The json-responses Reference Manual

Table of Contents

The json-responses Reference Manual

This is the json-responses Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:32:36 2021 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.

2.1 json-responses

Author

Brad Melanson <bradmelanson@icloud.com>

License

MIT

Description

Canned JSON responses for Hunchentoot

Dependencies

• hunchentoot
• cl-json

Source

json-responses.asd (file)

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.

3.1 Lisp

3.1.1 json-responses.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/json-responses-20190307-hg/json-responses.asd

Systems

json-responses (system)

3.1.2 json-responses/package.lisp

Parent

json-responses (system)

Location

package.lisp

Packages

ca.pinecode.json-responses

3.1.3 json-responses/json-responses.lisp

Dependency

package.lisp (file)

Parent

json-responses (system)

Location

json-responses.lisp

Exported Definitions

• 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)

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 ca.pinecode.json-responses

Source

package.lisp (file)

Nickname

json-responses

Use List

• json
• hunchentoot
• common-lisp

Exported Definitions

• 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)

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: accepted-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: authorization-required-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: bad-gateway-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: bad-request-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: conflict-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: continue-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: created-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: expectation-failed-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: forbidden-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: gateway-timeout-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: gone-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: http-version-not-supported-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: internal-server-error-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: json-response &key STATUS HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: length-required-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: method-not-allowed-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: moved-permanently-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: moved-temporarily-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: multiple-choices-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: no-content-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: non-authoritative-information-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: not-acceptable-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: not-found-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: not-implemented-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: not-modified-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: ok-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: partial-content-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: precondition-failed-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: proxy-authentication-required-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: request-entity-too-large-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: request-timeout-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: request-uri-too-long-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: requested-range-not-satisfiable-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: reset-content-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: see-other-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: service-unavailable-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: switching-protocols-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: temporary-redirect-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: unsupported-media-type-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Function: use-proxy-response &key HEADERS ERROR DATA

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

5.2 Internal definitions

5.2.1 Macros

Macro: define-json-response NAME STATUS &optional ERROR

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

5.2.2 Functions

Function: set-headers-from-alist HEADERS

Package

ca.pinecode.json-responses

Source

json-responses.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types