Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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.
Next: Systems, Previous: The webapi Reference Manual, Up: The webapi Reference Manual [Contents][Index]
CLOS-based wrapper builder for Web APIs.
(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"))
Copyright (c) 2017 Eitaro Fukamachi (e.arrows@gmail.com)
Licensed under the BSD 2-Clause License.
Next: Files, Previous: Introduction, Up: The webapi Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Next: webapi/main, Previous: Systems, Up: Systems [Contents][Index]
CLOS-based wrapper builder for Web APIs
Eitaro Fukamachi
BSD 2-Clause
0.1.0
webapi/main (system).
Next: webapi/request, Previous: webapi, Up: Systems [Contents][Index]
Eitaro Fukamachi
BSD 2-Clause
Next: webapi/response, Previous: webapi/main, Up: Systems [Contents][Index]
Eitaro Fukamachi
BSD 2-Clause
Next: webapi/codable, Previous: webapi/request, Up: Systems [Contents][Index]
Eitaro Fukamachi
BSD 2-Clause
Previous: webapi/response, Up: Systems [Contents][Index]
Eitaro Fukamachi
BSD 2-Clause
Next: Packages, Previous: Systems, Up: The webapi Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: webapi/main/file-type.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
webapi (system).
Next: webapi/request/file-type.lisp, Previous: webapi/webapi.asd, Up: Lisp [Contents][Index]
webapi/main (system).
Next: webapi/response/file-type.lisp, Previous: webapi/main/file-type.lisp, Up: Lisp [Contents][Index]
webapi/request (system).
contains-class-or-subclasses (function).
Next: webapi/codable/file-type.lisp, Previous: webapi/request/file-type.lisp, Up: Lisp [Contents][Index]
webapi/response (system).
Previous: webapi/response/file-type.lisp, Up: Lisp [Contents][Index]
webapi/codable (system).
Next: Definitions, Previous: Files, Up: The webapi Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: webapi/response, Previous: Packages, Up: Packages [Contents][Index]
webapi/main
Next: webapi/codable, Previous: webapi, Up: Packages [Contents][Index]
common-lisp.
Next: webapi/request, Previous: webapi/response, Up: Packages [Contents][Index]
common-lisp.
Previous: webapi/codable, Up: Packages [Contents][Index]
common-lisp.
contains-class-or-subclasses (function).
Next: Indexes, Previous: Packages, Up: The webapi Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
Next: Standalone methods, Previous: Macros, Up: Public Interface [Contents][Index]
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
sb-mop.
sb-mop.
sb-mop.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
standard-class.
:http
:status
This slot is read-only.
:headers
This slot is read-only.
:body
This slot is read-only.
:uri
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]
automatically generated reader method
key.
automatically generated writer method
key.
Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]
error.
Previous: Definitions, Up: The webapi Reference Manual [Contents][Index]
Jump to: | %
(
B C D E F G H I M P Q R S V W |
---|
Jump to: | %
(
B C D E F G H I M P Q R S V W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
B C H K S U |
---|
Jump to: | *
B C H K S U |
---|
Jump to: | C F P R S W |
---|
Jump to: | C F P R S W |
---|