pyechonext.apidoc_ui package

Submodules

pyechonext.apidoc_ui.api_documentation module

class pyechonext.apidoc_ui.api_documentation.APIDocumentation(app: EchoNext)[source]

Bases: object

This class describes an API documentation.

__init__(app: EchoNext)[source]

Constructs a new instance

Parameters:

app (Optional[EchoNext]) – echonext WSGI app. Defaults to None.

generate_spec() → dict[source]

Generate simple OpenAPI configuration from routes

Returns:

openapi configuration

Return type:

dict

init_app(app: EchoNext)[source]

Initialize application

Parameters:

app (EchoNext) – echonext WSGI app

pyechonext.apidoc_ui.ui module

class pyechonext.apidoc_ui.ui.APIDocUI(specification: dict)[source]

Bases: object

This class describes an api document ui.

__init__(specification: dict)[source]

Constructs a new instance.

Parameters:

specification (dict) – The specification

generate_html_page() → str[source]

Generate html page template

Returns:

template

Return type:

str

generate_section(route: str, summary_get: str, summary_post: str, get_responses: dict, post_responses: dict, value: dict) → str[source]

generate section

Parameters:

  • route (str) – The route

  • summary_get (str) – The summary get

  • summary_post (str) – The summary post

  • get_responses (dict) – The get responses

  • post_responses (dict) – The post responses

Returns:

template section

Return type:

str

Module contents