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

The cl-swagger Reference Manual

This is the cl-swagger Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:45:45 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The cl-swagger Reference Manual, Up: The cl-swagger Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-swagger Reference Manual [Contents][Index]

2 Systems

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

cl-swagger

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

2.1 `cl-swagger`

code generatter for swagger

Author

Inchul <ijung@mapr.com>

License

BSD

Dependencies

drakma (system).
cl-json (system).
cl-ppcre (system).
cl-mustache (system).

Source

cl-swagger.asd.

Child Components

package.lisp (file).
code-gen.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-swagger Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

cl-swagger/cl-swagger.asd
cl-swagger/package.lisp
cl-swagger/code-gen.lisp

Next: cl-swagger/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-swagger/cl-swagger.asd`

Source: cl-swagger.asd.
Parent Component: cl-swagger (system).
ASDF Systems: cl-swagger.

Next: cl-swagger/code-gen.lisp, Previous: cl-swagger/cl-swagger.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-swagger/package.lisp`

Source: cl-swagger.asd.
Parent Component: cl-swagger (system).
Packages: cl-swagger.

Previous: cl-swagger/package.lisp, Up: Lisp [Contents][Index]

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

*parameter-pattern* (special variable).
fetch-json (function).
generate-client-with-json (function).
get-basepath (function).
get-host (function).
get-in (function).
get-schemes (function).
make-urls (function).
normalize-path-name (function).
normalize-path-url (function).
parse-path-parameters (function).
rest-call (function).

Next: Definitions, Previous: Files, Up: The cl-swagger Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-swagger

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

4.1 `cl-swagger`

Source

package.lisp.

Use List

cl-ppcre.
common-lisp.
drakma.
json.
mustache.

Public Interface

generate-client (function).

Internals

*parameter-pattern* (special variable).
fetch-json (function).
generate-client-with-json (function).
get-basepath (function).
get-host (function).
get-in (function).
get-schemes (function).
make-urls (function).
normalize-path-name (function).
normalize-path-url (function).
parse-path-parameters (function).
rest-call (function).

Next: Indexes, Previous: Packages, Up: The cl-swagger Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

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

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.

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

5.2 Internals

Special variables
Ordinary functions

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

5.2.1 Special variables

Special Variable: *parameter-pattern* ¶

Package: cl-swagger.
Source: code-gen.lisp.

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

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.

Previous: Definitions, Up: The cl-swagger Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	F G M N P R

	Index Entry		Section

F
	`fetch-json`:		Private ordinary functions
	`Function, fetch-json`:		Private ordinary functions
	`Function, generate-client`:		Public ordinary functions
	`Function, generate-client-with-json`:		Private ordinary functions
	`Function, get-basepath`:		Private ordinary functions
	`Function, get-host`:		Private ordinary functions
	`Function, get-in`:		Private ordinary functions
	`Function, get-schemes`:		Private ordinary functions
	`Function, make-urls`:		Private ordinary functions
	`Function, normalize-path-name`:		Private ordinary functions
	`Function, normalize-path-url`:		Private ordinary functions
	`Function, parse-path-parameters`:		Private ordinary functions
	`Function, rest-call`:		Private ordinary functions

G
	`generate-client`:		Public ordinary functions
	`generate-client-with-json`:		Private ordinary functions
	`get-basepath`:		Private ordinary functions
	`get-host`:		Private ordinary functions
	`get-in`:		Private ordinary functions
	`get-schemes`:		Private ordinary functions

M
	`make-urls`:		Private ordinary functions

N
	`normalize-path-name`:		Private ordinary functions
	`normalize-path-url`:		Private ordinary functions

P
	`parse-path-parameters`:		Private ordinary functions

R
	`rest-call`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`parameter-pattern`:		Private special variables

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

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

A.4 Data types

Jump to:	C F P S

	Index Entry		Section

C
	`cl-swagger`:		The cl-swagger system
	`cl-swagger`:		The cl-swagger package
	`cl-swagger.asd`:		The cl-swagger/cl-swagger․asd file
	`code-gen.lisp`:		The cl-swagger/code-gen․lisp file

F
	`File, cl-swagger.asd`:		The cl-swagger/cl-swagger․asd file
	`File, code-gen.lisp`:		The cl-swagger/code-gen․lisp file
	`File, package.lisp`:		The cl-swagger/package․lisp file

P
	`Package, cl-swagger`:		The cl-swagger package
	`package.lisp`:		The cl-swagger/package․lisp file

S
	`System, cl-swagger`:		The cl-swagger system