Skip to main content

Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML.

Project description

Build pypi versions license codecov

essentials-openapi

Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML, and to generate other kinds of documents from OpenAPI Documentation files.

pip install essentials-openapi

To install with dependencies to generate other kinds of artifacts from source OpenAPI Documentation files:

pip install essentials-openapi[full]

Useful links

Usage

This library has been originally created to implement generation of OpenAPI Documentation in the BlackSheep web framework. However, this package is abstracted from that web framework and can be reused for other applications. Today this library also offers functions to generate documentation from source OpenAPI Documentation files.

Features to generate artifacts from Open API Documentation

These require the full package: install it using pip install essentials-openapi[full].

To generate output for MkDocs and PyMdown extentions:

oad gen-docs -s example1-openapi.json -d output.md

Example MkDocs documentation

Example of MkDocs documentation generated using Neoteroi/mkdocs-plugins.


To generate a PlantUML class diagram of the components schemas:

oad gen-docs -s source-openapi.json -d schemas.wsd --style "PLANTUML_SCHEMAS"

Example schemas

Example of PlantUML diagram generated from components schemas.


To generate a PlantUML class diagram with an overview of API endpoints:

oad gen-docs -s source-openapi.json -d schemas.wsd --style "PLANTUML_API"

Example api overview

Example of PlantUML diagram generated from path items.

Goals

  • Provide an API to generate OpenAPI Documentation files.
  • Providing functions to handle OpenAPI Documentation, like those to generate other kinds of documentation from source OpenAPI Documentation files.
  • Support enough features to be useful for the most common API scenarios, especially for OAD files that are generated automatically from web frameworks.

Non-Goals

  • To implement the whole OAD Specification.
  • For the features that generate artifacts: OpenAPI Documentation files are supposed to be coming from trusted sources. Trying to handle source files from untrusted sources and potentially causing HTML injection is out of the scope of this library.

Limitations

  • Partial support for Parameter properties: style, allow_reserved, explode are not handled.
  • Doesn't implement validation of values, currently it is only concerned in generating code from a higher level API (it might be extended in the future with classes for validation).
  • The features to generate artifacts from OpenAPI Documentation currently support only Version 3 of the specification.

Styles

Style Int value Description
MKDOCS 1 Markdown for MkDocs and PyMdown extensions.
MARKDOWN 2 Basic Markdown.
HTML 3 Plain HTML (planned, not yet implemented).
PLANTUML_SCHEMAS 100 PlantUML schema for components schemas.
PLANTUML_API 101 PlantUML schema for API endpoints.

Supported sources for OpenAPI Documentation

Source Example
YAML file ./docs/swagger.yaml
JSON file ./docs/swagger.json
URL returning YAML on HTTP GET https://example-domain.net/swagger/v1/swagger.yaml
URL returning JSON on HTTP GET https://example-domain.net/swagger/v1/swagger.json

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

essentials_openapi-1.2.0.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

essentials_openapi-1.2.0-py3-none-any.whl (54.0 kB view details)

Uploaded Python 3

File details

Details for the file essentials_openapi-1.2.0.tar.gz.

File metadata

  • Download URL: essentials_openapi-1.2.0.tar.gz
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for essentials_openapi-1.2.0.tar.gz
Algorithm Hash digest
SHA256 dbaf03130048e5522043b32f16b1f13deafa5b37449a698912c20b651d823588
MD5 e846f15061082ba095510adeecac0e85
BLAKE2b-256 48b44ada30c83b0f3322a89ccdcc0b0ad0b94a04d36f444280bfd68bd47ef3a8

See more details on using hashes here.

File details

Details for the file essentials_openapi-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for essentials_openapi-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 739d043ad380f8409af4b5b33e911492af7debe2223af9b7483fbd7f1d32fb34
MD5 dda5232387c6b2bc42d01df833e56871
BLAKE2b-256 6d8d4de1296b7f736b555a2c32e6705a04e9e92498be5c0d3196286462810910

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page