The http-body Reference Manual

Table of Contents

The http-body Reference Manual

This is the http-body Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:57:08 2018 GMT+0.

1 Introduction

HTTP-Body

HTTP-Body parses HTTP POST data and returns POST parameters. It supports application/x-www-form-urlencoded, application/json, and multipart/form-data.

Usage

http-body package exports only a function parse, which takes exact 2 arguments -- a string of Content-Type and a stream of HTTP POST data.

(http-body:parse "application/x-www-form-urlencoded"
                 body-stream)
;=> (("name" . "Eitaro"))
;   T

It returns parsed parameters in an association list.

If the Content-Type of first argument isn't supported, it returns NIL.

(http-body:parse "text/plain" body-stream)
;=> NIL
;   NIL

Installation

mkdir -p ~/common-lisp
cd ~/common-lisp
git clone https://github.com/fukamachi/xsubseq
git clone https://github.com/fukamachi/fast-http

(ql:quickload :http-body)

Author

• Eitaro Fukamachi

Copyright

Copyright (c) 2014 Eitaro Fukamachi

License

Licensed under the BSD 2-Clause License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 http-body

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

HTTP POST data parser for Common Lisp

Long Description

# HTTP-Body

[](https://travis-ci.org/fukamachi/http-body)

HTTP-Body parses HTTP POST data and returns POST parameters. It supports application/x-www-form-urlencoded, application/json, and multipart/form-data.

## Usage

‘http-body‘ package exports only a function ‘parse‘, which takes exact 2 arguments – a string of Content-Type and a stream of HTTP POST data.

“‘common-lisp
(http-body:parse "application/x-www-form-urlencoded"
body-stream)
;=> (("name" . "Eitaro"))
; T
“‘

It returns parsed parameters in an association list.

If the Content-Type of first argument isn’t supported, it returns ‘NIL‘.

“‘common-lisp
(http-body:parse "text/plain" body-stream)
;=> NIL
; NIL
“‘

## Installation

“‘
mkdir -p ~/common-lisp
cd ~/common-lisp
git clone https://github.com/fukamachi/xsubseq
git clone https://github.com/fukamachi/fast-http
“‘

“‘common-lisp
(ql:quickload :http-body)
“‘

## Author

* Eitaro Fukamachi

## Copyright

Copyright (c) 2014 Eitaro Fukamachi

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies

• fast-http
• jonathan
• trivial-gray-streams
• quri
• flexi-streams
• babel
• cl-ppcre
• cl-utilities

Source

http-body.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 http-body/src

Parent

http-body (system)

Location

src/

Components

• http-body.lisp (file)
• multipart.lisp (file)
• json.lisp (file)
• urlencoded.lisp (file)
• util.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 http-body.asd

Location

http-body.asd

Systems

http-body (system)

Packages

http-body-asd

4.1.2 http-body/src/http-body.lisp

Dependencies

• multipart.lisp (file)
• json.lisp (file)
• urlencoded.lisp (file)

Parent

src (module)

Location

src/http-body.lisp

Packages

http-body

Exported Definitions

parse (function)

Internal Definitions

*content-type-map* (special variable)

4.1.3 http-body/src/multipart.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/multipart.lisp

Packages

http-body.multipart

Exported Definitions

multipart-parse (function)

4.1.4 http-body/src/json.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/json.lisp

Packages

http-body.json

Exported Definitions

json-parse (function)

4.1.5 http-body/src/urlencoded.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/urlencoded.lisp

Packages

http-body.urlencoded

Exported Definitions

urlencoded-parse (function)

4.1.6 http-body/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

http-body.util

Exported Definitions

• detect-charset (function)
• slurp-stream (function)

Internal Definitions

parse-content-type (function)

5 Packages

Packages are listed by definition order.

5.1 http-body-asd

Source

http-body.asd

Use List

• asdf/interface
• common-lisp

5.2 http-body

Source

http-body.lisp (file)

Use List

common-lisp

Exported Definitions

parse (function)

Internal Definitions

*content-type-map* (special variable)

5.3 http-body.multipart

Source

multipart.lisp (file)

Use List

common-lisp

Exported Definitions

multipart-parse (function)

5.4 http-body.json

Source

json.lisp (file)

Use List

common-lisp

Exported Definitions

json-parse (function)

5.5 http-body.urlencoded

Source

urlencoded.lisp (file)

Use List

common-lisp

Exported Definitions

urlencoded-parse (function)

5.6 http-body.util

Source

util.lisp (file)

Use List

common-lisp

Exported Definitions

• detect-charset (function)
• slurp-stream (function)

Internal Definitions

parse-content-type (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Functions

Function: detect-charset CONTENT-TYPE &optional DEFAULT

Package

http-body.util

Source

util.lisp (file)

Function: json-parse CONTENT-TYPE CONTENT-LENGTH STREAM

Package

http-body.json

Source

json.lisp (file)

Function: multipart-parse CONTENT-TYPE CONTENT-LENGTH STREAM

Package

http-body.multipart

Source

multipart.lisp (file)

Function: parse CONTENT-TYPE CONTENT-LENGTH STREAM

Package

http-body

Source

http-body.lisp (file)

Function: slurp-stream STREAM &optional CONTENT-LENGTH

Package

http-body.util

Source

util.lisp (file)

Function: urlencoded-parse CONTENT-TYPE CONTENT-LENGTH STREAM

Package

http-body.urlencoded

Source

urlencoded.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *content-type-map*

Package

http-body

Source

http-body.lisp (file)

6.2.2 Functions

Function: parse-content-type CONTENT-TYPE

Package

http-body.util

Source

util.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types