The webapi Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The webapi Reference Manual

This is the webapi Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 06:08:58 2022 GMT+0.

Table of Contents

Next: , Previous: , Up: The webapi Reference Manual   [Contents][Index]

1 Introduction

WebAPI

CLOS-based wrapper builder for Web APIs.

Usage

(ql:quickload '(:webapi :jonathan))

;; Define GitHub API request class.
(defclass github-request () ()
  (:default-initargs :base-uri "https://api.github.com"))
  
(defmethod webapi:parse ((request github-request) response)
  (jojo:parse (webapi:response-body response) :as :alist))

;; Request class for /users/:name/repos.
(defclass user-repositories (github-request)
  ((user :initarg :user))
  (:metaclass webapi:request-class)
  (:http :get))
  
(defmethod webapi:request-path ((request user-repositories))
  (format nil "/users/~A/repos" (slot-value request 'user)))

;; Request class for /search/repositories.
(defclass search-repositories (github-request)
  ((q :initarg :q))
  (:metaclass webapi:request-class)
  (:http :get "/search/repositories"))
  
(defmethod webapi:query-parameters ((request search-repositories))
  `(("q" . ,(slot-value request 'q))))
  
;;
;; Send a request

;; Get repositories of "fukamachi".
(webapi:send (make-instance 'user-repositories :user "fukamachi"))

;; Search repositories with related to "Common Lisp".
(webapi:send (make-instance 'search-repositories :q "Common Lisp"))

Author

Copyright

Copyright (c) 2017 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the BSD 2-Clause License.

Next: , Previous: , Up: The webapi Reference Manual   [Contents][Index]

2 Systems

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

Next: , Previous: , Up: Systems   [Contents][Index]

2.1 webapi

CLOS-based wrapper builder for Web APIs

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.1.0

Dependency

webapi/main (system).

Source

webapi.asd.

Next: , Previous: , Up: Systems   [Contents][Index]

2.2 webapi/main

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
Source

webapi.asd.

Next: , Previous: , Up: Systems   [Contents][Index]

2.3 webapi/request

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
  • webapi/response (system).
  • closer-mop (system).
  • dexador (system).
  • quri (system).
  • kebab (system).
Source

webapi.asd.

Next: , Previous: , Up: Systems   [Contents][Index]

2.4 webapi/response

Author

Eitaro Fukamachi

License

BSD 2-Clause

Source

webapi.asd.

Previous: , Up: Systems   [Contents][Index]

2.5 webapi/codable

Author

Eitaro Fukamachi

License

BSD 2-Clause

Dependencies
  • closer-mop (system).
  • st-json (system).
  • alexandria (system).
Source

webapi.asd.

Next: , Previous: , Up: The webapi Reference Manual   [Contents][Index]

3 Files

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

Previous: , Up: Files   [Contents][Index]

3.1 Lisp

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 webapi/webapi.asd

Source

webapi.asd.

Parent Component

webapi (system).

ASDF Systems

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.2 webapi/main/file-type.lisp

Source

webapi.asd.

Parent Component

webapi/main (system).

Packages

webapi.

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.3 webapi/request/file-type.lisp

Source

webapi.asd.

Parent Component

webapi/request (system).

Packages

webapi/request.

Public Interface
Internals

contains-class-or-subclasses (function).

Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.4 webapi/response/file-type.lisp

Source

webapi.asd.

Parent Component

webapi/response (system).

Packages

webapi/response.

Public Interface

Previous: , Up: Lisp   [Contents][Index]

3.1.5 webapi/codable/file-type.lisp

Source

webapi.asd.

Parent Component

webapi/codable (system).

Packages

webapi/codable.

Public Interface
Internals

Next: , Previous: , Up: The webapi Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

Next: , Previous: , Up: Packages   [Contents][Index]

4.1 webapi

Source

file-type.lisp.

Nickname

webapi/main

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 webapi/response

Source

file-type.lisp.

Use List

common-lisp.

Used By List

webapi.

Public Interface

Next: , Previous: , Up: Packages   [Contents][Index]

4.3 webapi/codable

Source

file-type.lisp.

Use List

common-lisp.

Used By List

webapi.

Public Interface
Internals

Previous: , Up: Packages   [Contents][Index]

4.4 webapi/request

Source

file-type.lisp.

Use List

common-lisp.

Used By List

webapi.

Public Interface
Internals

contains-class-or-subclasses (function).

Next: , Previous: , Up: The webapi Reference Manual   [Contents][Index]

5 Definitions

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

Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Special variables

Special Variable: *keep-alive*
Package

webapi/request.

Source

file-type.lisp.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.2 Macros

Macro: defcodable (name superclasses slots &rest class-options)
Package

webapi/codable.

Source

file-type.lisp.

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.3 Generic functions

Generic Function: body-parameters (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: body-parameters ((request request))
Generic Function: decode-object (input class)
Package

webapi/codable.

Source

file-type.lisp.

Methods
Method: decode-object (input (class null))
Method: decode-object (input (class symbol))
Method: decode-object ((input string) class)
Method: decode-object ((input jso) class)
Method: decode-object ((input cons) (class codable-class))
Generic Function: encode-object (object)
Package

webapi/codable.

Source

file-type.lisp.

Methods
Method: encode-object (object)
Method: encode-object ((object codable))
Generic Function: http-method (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: http-method ((request request))
Generic Function: http-uri (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: http-uri ((request request))
Generic Function: parse (request response)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: parse (request response)
Generic Function: query-parameters (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: query-parameters ((request request))
Generic Function: request-headers (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: request-headers ((request request))
Generic Function: request-parameters (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: request-parameters ((request request))
Generic Function: request-path (request)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: request-path ((request request))
Generic Reader: response-body (object)
Package

webapi/response.

Methods
Reader Method: response-body ((response response))

automatically generated reader method

Source

file-type.lisp.

Target Slot

body.

Generic Reader: response-headers (object)
Package

webapi/response.

Methods
Reader Method: response-headers ((response response))

automatically generated reader method

Source

file-type.lisp.

Target Slot

headers.

Generic Reader: response-status (object)
Package

webapi/response.

Methods
Reader Method: response-status ((response response))

automatically generated reader method

Source

file-type.lisp.

Target Slot

status.

Generic Reader: response-uri (object)
Package

webapi/response.

Methods
Reader Method: response-uri ((response response))

automatically generated reader method

Source

file-type.lisp.

Target Slot

uri.

Generic Function: send (request &key keep-alive)
Package

webapi/request.

Source

file-type.lisp.

Methods
Method: send ((request request) &key keep-alive)

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.4 Standalone methods

Method: direct-slot-definition-class ((class codable-class) &key &allow-other-keys)
Package

sb-mop.

Source

file-type.lisp.

Method: initialize-instance :around ((class codable-class) &rest initargs &key conc-name &allow-other-keys)
Source

file-type.lisp.

Method: initialize-instance :around ((class codable-slot-class) &rest rest-initargs &key name &allow-other-keys)
Source

file-type.lisp.

Method: initialize-instance :around ((class request-class) &rest initargs &key direct-superclasses &allow-other-keys)
Source

file-type.lisp.

Method: reinitialize-instance :around ((class codable-class) &rest initargs &key conc-name &allow-other-keys)
Source

file-type.lisp.

Method: reinitialize-instance :around ((class request-class) &rest initargs &key direct-superclasses &allow-other-keys)
Source

file-type.lisp.

Method: validate-superclass ((class codable-class) (super standard-class))
Package

sb-mop.

Source

file-type.lisp.

Method: validate-superclass ((class request-class) (super standard-class))
Package

sb-mop.

Source

file-type.lisp.

Method: write-json-element ((object codable) stream)
Package

st-json.

Source

file-type.lisp.

Previous: , Up: Public Interface   [Contents][Index]

5.1.5 Classes

Class: codable
Package

webapi/codable.

Source

file-type.lisp.

Direct methods
Class: codable-class
Package

webapi/codable.

Source

file-type.lisp.

Direct superclasses

standard-class.

Direct methods
Direct slots
Slot: conc-name
Initargs

:conc-name

Slot: key-mapper
Initform

(make-hash-table :test (quote equal))

Class: request
Package

webapi/request.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: base-uri
Initargs

:base-uri

Class: request-class
Package

webapi/request.

Source

file-type.lisp.

Direct superclasses

standard-class.

Direct methods
Direct slots
Slot: http
Initargs

:http

Class: response
Package

webapi/response.

Source

file-type.lisp.

Direct methods
Direct slots
Slot: status
Initargs

:status

Readers

response-status.

Writers

This slot is read-only.

Slot: headers
Initargs

:headers

Readers

response-headers.

Writers

This slot is read-only.

Slot: body
Initargs

:body

Readers

response-body.

Writers

This slot is read-only.

Slot: uri
Initargs

:uri

Readers

response-uri.

Writers

This slot is read-only.

Previous: , Up: Definitions   [Contents][Index]

5.2 Internals

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *conc-name*
Package

webapi/codable.

Source

file-type.lisp.

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary functions

Function: build-slot-mapper (class)
Package

webapi/codable.

Source

file-type.lisp.

Function: codable-slot-key (slot)
Package

webapi/codable.

Source

file-type.lisp.

Function: contains-class-or-subclasses (class target-classes)
Package

webapi/request.

Source

file-type.lisp.

Function: decode-jso-as-type (value type)
Package

webapi/codable.

Source

file-type.lisp.

Function: make-slot-decoder (type)
Package

webapi/codable.

Source

file-type.lisp.

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.3 Generic functions

Generic Reader: %codable-slot-key (object)
Package

webapi/codable.

Methods
Reader Method: %codable-slot-key ((codable-slot-class codable-slot-class))

automatically generated reader method

Source

file-type.lisp.

Target Slot

key.

Generic Writer: (setf %codable-slot-key) (object)
Package

webapi/codable.

Methods
Writer Method: (setf %codable-slot-key) ((codable-slot-class codable-slot-class))

automatically generated writer method

Source

file-type.lisp.

Target Slot

key.

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.4 Conditions

Condition: conversion-failed
Package

webapi/codable.

Source

file-type.lisp.

Direct superclasses

error.

Previous: , Up: Internals   [Contents][Index]

5.2.5 Classes

Class: codable-slot-class
Package

webapi/codable.

Source

file-type.lisp.

Direct superclasses

standard-direct-slot-definition.

Direct methods
Direct slots
Slot: key
Type

(or string null)

Initargs

:key

Readers

%codable-slot-key.

Writers

(setf %codable-slot-key).

Previous: , Up: The webapi Reference Manual   [Contents][Index]

Appendix A Indexes

Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
B   C   D   E   F   G   H   I   M   P   Q   R   S   V   W  
Index Entry  Section
%
%codable-slot-key: Private generic functions
%codable-slot-key: Private generic functions
(
(setf %codable-slot-key): Private generic functions
(setf %codable-slot-key): Private generic functions
B
body-parameters: Public generic functions
body-parameters: Public generic functions
build-slot-mapper: Private ordinary functions
C
codable-slot-key: Private ordinary functions
contains-class-or-subclasses: Private ordinary functions
D
decode-jso-as-type: Private ordinary functions
decode-object: Public generic functions
decode-object: Public generic functions
decode-object: Public generic functions
decode-object: Public generic functions
decode-object: Public generic functions
decode-object: Public generic functions
defcodable: Public macros
direct-slot-definition-class: Public standalone methods
E
encode-object: Public generic functions
encode-object: Public generic functions
encode-object: Public generic functions
F
Function, build-slot-mapper: Private ordinary functions
Function, codable-slot-key: Private ordinary functions
Function, contains-class-or-subclasses: Private ordinary functions
Function, decode-jso-as-type: Private ordinary functions
Function, make-slot-decoder: Private ordinary functions
G
Generic Function, %codable-slot-key: Private generic functions
Generic Function, (setf %codable-slot-key): Private generic functions
Generic Function, body-parameters: Public generic functions
Generic Function, decode-object: Public generic functions
Generic Function, encode-object: Public generic functions
Generic Function, http-method: Public generic functions
Generic Function, http-uri: Public generic functions
Generic Function, parse: Public generic functions
Generic Function, query-parameters: Public generic functions
Generic Function, request-headers: Public generic functions
Generic Function, request-parameters: Public generic functions
Generic Function, request-path: Public generic functions
Generic Function, response-body: Public generic functions
Generic Function, response-headers: Public generic functions
Generic Function, response-status: Public generic functions
Generic Function, response-uri: Public generic functions
Generic Function, send: Public generic functions
H
http-method: Public generic functions
http-method: Public generic functions
http-uri: Public generic functions
http-uri: Public generic functions
I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
M
Macro, defcodable: Public macros
make-slot-decoder: Private ordinary functions
Method, %codable-slot-key: Private generic functions
Method, (setf %codable-slot-key): Private generic functions
Method, body-parameters: Public generic functions
Method, decode-object: Public generic functions
Method, decode-object: Public generic functions
Method, decode-object: Public generic functions
Method, decode-object: Public generic functions
Method, decode-object: Public generic functions
Method, direct-slot-definition-class: Public standalone methods
Method, encode-object: Public generic functions
Method, encode-object: Public generic functions
Method, http-method: Public generic functions
Method, http-uri: Public generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, parse: Public generic functions
Method, query-parameters: Public generic functions
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, request-headers: Public generic functions
Method, request-parameters: Public generic functions
Method, request-path: Public generic functions
Method, response-body: Public generic functions
Method, response-headers: Public generic functions
Method, response-status: Public generic functions
Method, response-uri: Public generic functions
Method, send: Public generic functions
Method, validate-superclass: Public standalone methods
Method, validate-superclass: Public standalone methods
Method, write-json-element: Public standalone methods
P
parse: Public generic functions
parse: Public generic functions
Q
query-parameters: Public generic functions
query-parameters: Public generic functions
R
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
request-headers: Public generic functions
request-headers: Public generic functions
request-parameters: Public generic functions
request-parameters: Public generic functions
request-path: Public generic functions
request-path: Public generic functions
response-body: Public generic functions
response-body: Public generic functions
response-headers: Public generic functions
response-headers: Public generic functions
response-status: Public generic functions
response-status: Public generic functions
response-uri: Public generic functions
response-uri: Public generic functions
S
send: Public generic functions
send: Public generic functions
V
validate-superclass: Public standalone methods
validate-superclass: Public standalone methods
W
write-json-element: Public standalone methods
Jump to:   %   (  
B   C   D   E   F   G   H   I   M   P   Q   R   S   V   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   P   R   S   W  
Index Entry  Section
C
Class, codable: Public classes
Class, codable-class: Public classes
Class, codable-slot-class: Private classes
Class, request: Public classes
Class, request-class: Public classes
Class, response: Public classes
codable: Public classes
codable-class: Public classes
codable-slot-class: Private classes
Condition, conversion-failed: Private conditions
conversion-failed: Private conditions
F
File, file-type.lisp: The webapi/main/file-type․lisp file
File, file-type.lisp: The webapi/request/file-type․lisp file
File, file-type.lisp: The webapi/response/file-type․lisp file
File, file-type.lisp: The webapi/codable/file-type․lisp file
File, webapi.asd: The webapi/webapi․asd file
file-type.lisp: The webapi/main/file-type․lisp file
file-type.lisp: The webapi/request/file-type․lisp file
file-type.lisp: The webapi/response/file-type․lisp file
file-type.lisp: The webapi/codable/file-type․lisp file
P
Package, webapi: The webapi package
Package, webapi/codable: The webapi/codable package
Package, webapi/request: The webapi/request package
Package, webapi/response: The webapi/response package
R
request: Public classes
request-class: Public classes
response: Public classes
S
System, webapi: The webapi system
System, webapi/codable: The webapi/codable system
System, webapi/main: The webapi/main system
System, webapi/request: The webapi/request system
System, webapi/response: The webapi/response system
W
webapi: The webapi system
webapi: The webapi package
webapi.asd: The webapi/webapi․asd file
webapi/codable: The webapi/codable system
webapi/codable: The webapi/codable package
webapi/main: The webapi/main system
webapi/request: The webapi/request system
webapi/request: The webapi/request package
webapi/response: The webapi/response system
webapi/response: The webapi/response package
Jump to:   C   F   P   R   S   W