Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
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]
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.
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 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 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 of PlantUML diagram generated from path items.
style
, allow_reserved
, explode
are not
handled.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. |
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 |
FAQs
Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML.
We found that essentials-openapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.