The json-responses Reference Manual

This is the json-responses Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:53:22 2022 GMT+0.

1 Introduction

This library provides a standard set of JSON responses for Hunchentoot applications. It's been tested on SBCL, CCL, CLISP, and LispWorks but should work anywhere that Hunchentoot and CL-JSON do. If it doesn't work on your Lisp of choice open an issue and I'll investigate.

Best enjoyed with Quicklisp:

(ql:quickload 'json-responses)

Or, to run the included test suite:

(ql:quickload 'json-responses)
(ql:quickload 'json-responses-test)

One generic function (json-response) can accept :status, :headers, :data, and :error keyword arguments:

(json-response :status +http-ok+
               :headers '(("X-HELLO" . "world"))
               :data "Hello, world!"
               :error "Not applicable here, but for demonstration...")

Which would respond with a 200 status code, an X-HELLO header with the value world, a content-type of application/json, and a JSON body like:

{
    "data": "Hello, world!",
    "error": "Not applicable here, but for demonstration..."
}

All keyword arguments are optional and have sane defaults. If both data and error are omitted then the body is simply null.

The remaining functions can accept :headers, :data, and :error keyword arguments and have status preset to an appropriate value. :data and :headers default to nil, :error defaults to nil for 100, 200, and 300-level responses and a simple error message for 400 and 500-level responses.

The following functions are included:

json-response
continue-response
switching-protocols-response
ok-response
created-response
accepted-response
non-authoritative-information-response
no-content-response
reset-content-response
partial-content-response
multiple-choices-response
moved-permanently-response
moved-temporarily-response
see-other-response
not-modified-response
use-proxy-response
temporary-redirect-response
bad-request-response
authorization-required-response
forbidden-response
not-found-response
method-not-allowed-response
not-acceptable-response
proxy-authentication-required-response
request-timeout-response
conflict-response
gone-response
length-required-response
precondition-failed-response
request-entity-too-large-response
request-uri-too-long-response
unsupported-media-type-response
requested-range-not-satisfiable-response
expectation-failed-response
internal-server-error-response
not-implemented-response
bad-gateway-response
service-unavailable-response
gateway-timeout-response
http-version-not-supported-response

2 Systems

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

json-responses

2.1 `json-responses`

Canned JSON responses for Hunchentoot

Author

Brad Melanson <bradmelanson@icloud.com>

License

MIT

Dependencies

hunchentoot (system).
cl-json (system).

Source

json-responses.asd.

Child Components

package.lisp (file).
json-responses.lisp (file).

3 Files

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

Lisp

3.1.1 `json-responses/json-responses.asd`

Source: json-responses.asd.
Parent Component: json-responses (system).
ASDF Systems: json-responses.

3.1.2 `json-responses/package.lisp`

Source: json-responses.asd.
Parent Component: json-responses (system).
Packages: ca.pinecode.json-responses.

3.1.3 `json-responses/json-responses.lisp`

Dependency

package.lisp (file).

Source

json-responses.asd.

Parent Component

json-responses (system).

Public Interface

accepted-response (function).
authorization-required-response (function).
bad-gateway-response (function).
bad-request-response (function).
conflict-response (function).
continue-response (function).
created-response (function).
expectation-failed-response (function).
forbidden-response (function).
gateway-timeout-response (function).
gone-response (function).
http-version-not-supported-response (function).
internal-server-error-response (function).
json-response (function).
length-required-response (function).
method-not-allowed-response (function).
moved-permanently-response (function).
moved-temporarily-response (function).
multiple-choices-response (function).
no-content-response (function).
non-authoritative-information-response (function).
not-acceptable-response (function).
not-found-response (function).
not-implemented-response (function).
not-modified-response (function).
ok-response (function).
partial-content-response (function).
precondition-failed-response (function).
proxy-authentication-required-response (function).
request-entity-too-large-response (function).
request-timeout-response (function).
request-uri-too-long-response (function).
requested-range-not-satisfiable-response (function).
reset-content-response (function).
see-other-response (function).
service-unavailable-response (function).
switching-protocols-response (function).
temporary-redirect-response (function).
unsupported-media-type-response (function).
use-proxy-response (function).

Internals

define-json-response (macro).
set-headers-from-alist (function).

4 Packages

Packages are listed by definition order.

ca.pinecode.json-responses

4.1 `ca.pinecode.json-responses`

Source

package.lisp.

Nickname

json-responses

Use List

common-lisp.
hunchentoot.
json.

Public Interface

accepted-response (function).
authorization-required-response (function).
bad-gateway-response (function).
bad-request-response (function).
conflict-response (function).
continue-response (function).
created-response (function).
expectation-failed-response (function).
forbidden-response (function).
gateway-timeout-response (function).
gone-response (function).
http-version-not-supported-response (function).
internal-server-error-response (function).
json-response (function).
length-required-response (function).
method-not-allowed-response (function).
moved-permanently-response (function).
moved-temporarily-response (function).
multiple-choices-response (function).
no-content-response (function).
non-authoritative-information-response (function).
not-acceptable-response (function).
not-found-response (function).
not-implemented-response (function).
not-modified-response (function).
ok-response (function).
partial-content-response (function).
precondition-failed-response (function).
proxy-authentication-required-response (function).
request-entity-too-large-response (function).
request-timeout-response (function).
request-uri-too-long-response (function).
requested-range-not-satisfiable-response (function).
reset-content-response (function).
see-other-response (function).
service-unavailable-response (function).
switching-protocols-response (function).
temporary-redirect-response (function).
unsupported-media-type-response (function).
use-proxy-response (function).

Internals

define-json-response (macro).
set-headers-from-alist (function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Ordinary functions

5.1.1 Ordinary functions

Function: accepted-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: authorization-required-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: bad-gateway-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: bad-request-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: conflict-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: continue-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: created-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: expectation-failed-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: forbidden-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: gateway-timeout-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: gone-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: http-version-not-supported-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: internal-server-error-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: json-response (&key status headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: length-required-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: method-not-allowed-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: moved-permanently-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: moved-temporarily-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: multiple-choices-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: no-content-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: non-authoritative-information-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: not-acceptable-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: not-found-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: not-implemented-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: not-modified-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: ok-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: partial-content-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: precondition-failed-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: proxy-authentication-required-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: request-entity-too-large-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: request-timeout-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: request-uri-too-long-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: requested-range-not-satisfiable-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: reset-content-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: see-other-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: service-unavailable-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: switching-protocols-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: temporary-redirect-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: unsupported-media-type-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Function: use-proxy-response (&key headers error data) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

5.2 Internals

Macros
Ordinary functions

5.2.1 Macros

Macro: define-json-response (name status &optional error) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

5.2.2 Ordinary functions

Function: set-headers-from-alist (headers) ¶

Package: ca.pinecode.json-responses.
Source: json-responses.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	A B C D E F G H I J L M N O P R S T U

	Index Entry	Section

A
	`accepted-response`:	Public ordinary functions
	`authorization-required-response`:	Public ordinary functions

B
	`bad-gateway-response`:	Public ordinary functions
	`bad-request-response`:	Public ordinary functions

C
	`conflict-response`:	Public ordinary functions
	`continue-response`:	Public ordinary functions
	`created-response`:	Public ordinary functions

D
	`define-json-response`:	Private macros

E
	`expectation-failed-response`:	Public ordinary functions

F
	`forbidden-response`:	Public ordinary functions
	`Function, accepted-response`:	Public ordinary functions
	`Function, authorization-required-response`:	Public ordinary functions
	`Function, bad-gateway-response`:	Public ordinary functions
	`Function, bad-request-response`:	Public ordinary functions
	`Function, conflict-response`:	Public ordinary functions
	`Function, continue-response`:	Public ordinary functions
	`Function, created-response`:	Public ordinary functions
	`Function, expectation-failed-response`:	Public ordinary functions
	`Function, forbidden-response`:	Public ordinary functions
	`Function, gateway-timeout-response`:	Public ordinary functions
	`Function, gone-response`:	Public ordinary functions
	`Function, http-version-not-supported-response`:	Public ordinary functions
	`Function, internal-server-error-response`:	Public ordinary functions
	`Function, json-response`:	Public ordinary functions
	`Function, length-required-response`:	Public ordinary functions
	`Function, method-not-allowed-response`:	Public ordinary functions
	`Function, moved-permanently-response`:	Public ordinary functions
	`Function, moved-temporarily-response`:	Public ordinary functions
	`Function, multiple-choices-response`:	Public ordinary functions
	`Function, no-content-response`:	Public ordinary functions
	`Function, non-authoritative-information-response`:	Public ordinary functions
	`Function, not-acceptable-response`:	Public ordinary functions
	`Function, not-found-response`:	Public ordinary functions
	`Function, not-implemented-response`:	Public ordinary functions
	`Function, not-modified-response`:	Public ordinary functions
	`Function, ok-response`:	Public ordinary functions
	`Function, partial-content-response`:	Public ordinary functions
	`Function, precondition-failed-response`:	Public ordinary functions
	`Function, proxy-authentication-required-response`:	Public ordinary functions
	`Function, request-entity-too-large-response`:	Public ordinary functions
	`Function, request-timeout-response`:	Public ordinary functions
	`Function, request-uri-too-long-response`:	Public ordinary functions
	`Function, requested-range-not-satisfiable-response`:	Public ordinary functions
	`Function, reset-content-response`:	Public ordinary functions
	`Function, see-other-response`:	Public ordinary functions
	`Function, service-unavailable-response`:	Public ordinary functions
	`Function, set-headers-from-alist`:	Private ordinary functions
	`Function, switching-protocols-response`:	Public ordinary functions
	`Function, temporary-redirect-response`:	Public ordinary functions
	`Function, unsupported-media-type-response`:	Public ordinary functions
	`Function, use-proxy-response`:	Public ordinary functions

G
	`gateway-timeout-response`:	Public ordinary functions
	`gone-response`:	Public ordinary functions

H
	`http-version-not-supported-response`:	Public ordinary functions

I
	`internal-server-error-response`:	Public ordinary functions

J
	`json-response`:	Public ordinary functions

L
	`length-required-response`:	Public ordinary functions

M
	`Macro, define-json-response`:	Private macros
	`method-not-allowed-response`:	Public ordinary functions
	`moved-permanently-response`:	Public ordinary functions
	`moved-temporarily-response`:	Public ordinary functions
	`multiple-choices-response`:	Public ordinary functions

N
	`no-content-response`:	Public ordinary functions
	`non-authoritative-information-response`:	Public ordinary functions
	`not-acceptable-response`:	Public ordinary functions
	`not-found-response`:	Public ordinary functions
	`not-implemented-response`:	Public ordinary functions
	`not-modified-response`:	Public ordinary functions

O
	`ok-response`:	Public ordinary functions

P
	`partial-content-response`:	Public ordinary functions
	`precondition-failed-response`:	Public ordinary functions
	`proxy-authentication-required-response`:	Public ordinary functions

R
	`request-entity-too-large-response`:	Public ordinary functions
	`request-timeout-response`:	Public ordinary functions
	`request-uri-too-long-response`:	Public ordinary functions
	`requested-range-not-satisfiable-response`:	Public ordinary functions
	`reset-content-response`:	Public ordinary functions

S
	`see-other-response`:	Public ordinary functions
	`service-unavailable-response`:	Public ordinary functions
	`set-headers-from-alist`:	Private ordinary functions
	`switching-protocols-response`:	Public ordinary functions

T
	`temporary-redirect-response`:	Public ordinary functions

U
	`unsupported-media-type-response`:	Public ordinary functions
	`use-proxy-response`:	Public ordinary functions

Jump to:	A B C D E F G H I J L M N O P R S T U

A.3 Variables

A.4 Data types

Jump to:	C F J P S

	Index Entry	Section

C
	`ca.pinecode.json-responses`:	The ca․pinecode․json-responses package

F
	`File, json-responses.asd`:	The json-responses/json-responses․asd file
	`File, json-responses.lisp`:	The json-responses/json-responses․lisp file
	`File, package.lisp`:	The json-responses/package․lisp file

J
	`json-responses`:	The json-responses system
	`json-responses.asd`:	The json-responses/json-responses․asd file
	`json-responses.lisp`:	The json-responses/json-responses․lisp file

P
	`Package, ca.pinecode.json-responses`:	The ca․pinecode․json-responses package
	`package.lisp`:	The json-responses/package․lisp file

S
	`System, json-responses`:	The json-responses system

Jump to:	C F J P S

The json-responses Reference Manual

The json-responses Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 json-responses

3 Files

3.1 Lisp

3.1.1 json-responses/json-responses.asd

3.1.2 json-responses/package.lisp

3.1.3 json-responses/json-responses.lisp

4 Packages

4.1 ca.pinecode.json-responses

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Macros

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `json-responses`

3.1.1 `json-responses/json-responses.asd`

3.1.2 `json-responses/package.lisp`

3.1.3 `json-responses/json-responses.lisp`

4.1 `ca.pinecode.json-responses`