The cl-swagger Reference Manual

This is the cl-swagger Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:32:22 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-swagger

code generatter for swagger

Author

Inchul <>

License

BSD

Dependencies
  • drakma (system).
  • cl-json (system).
  • cl-ppcre (system).
  • cl-mustache (system).
Source

cl-swagger.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-swagger/cl-swagger.asd

Source

cl-swagger.asd.

Parent Component

cl-swagger (system).

ASDF Systems

cl-swagger.


3.1.2 cl-swagger/package.lisp

Source

cl-swagger.asd.

Parent Component

cl-swagger (system).

Packages

cl-swagger.


3.1.3 cl-swagger/code-gen.lisp

Dependency

package.lisp (file).

Source

cl-swagger.asd.

Parent Component

cl-swagger (system).

Public Interface

generate-client (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 cl-swagger

Source

package.lisp.

Use List
  • cl-ppcre.
  • common-lisp.
  • drakma.
  • json.
  • mustache.
Public Interface

generate-client (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: generate-client (url filepath &optional accept accept-type)

exposing function for client code generater

Package

cl-swagger.

Source

code-gen.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *parameter-pattern*
Package

cl-swagger.

Source

code-gen.lisp.


5.2.2 Ordinary functions

Function: fetch-json (this-url)

gets JSON with this URL only when response-code is 200

Package

cl-swagger.

Source

code-gen.lisp.

Function: generate-client-with-json (json filepath &optional accept accept-type)

generater a lisp code with swagger-json

Package

cl-swagger.

Source

code-gen.lisp.

Function: get-basepath (json)

gets base-path

Package

cl-swagger.

Source

code-gen.lisp.

Function: get-host (json)

gets hostname

Package

cl-swagger.

Source

code-gen.lisp.

Function: get-in (this-items alist)

get lists related to this-items

Package

cl-swagger.

Source

code-gen.lisp.

Function: get-schemes (json)

gets schemes

Package

cl-swagger.

Source

code-gen.lisp.

Function: make-urls (json)

scheme + hostname + basepath

Package

cl-swagger.

Source

code-gen.lisp.

Function: normalize-path-name (name)

string –> A-B-C

Package

cl-swagger.

Source

code-gen.lisp.

Function: normalize-path-url (path-url)

string –> A/B/C

Package

cl-swagger.

Source

code-gen.lisp.

Function: parse-path-parameters (path)

returns two values, 1st is non param path element, 2nd are the params. ex) /PARAM1/{PARAM2} ==> (("PARAM1") ("PARAM2"))

Package

cl-swagger.

Source

code-gen.lisp.

Function: rest-call (host url-path &key params content basic-authorization method accept content-type)

call http-request with basic params and conteent and authorization

Package

cl-swagger.

Source

code-gen.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*parameter-pattern*: Private special variables

S
Special Variable, *parameter-pattern*: Private special variables