Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML
Project description
essentials-openapi
Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML.
pip install essentials-openapi
Useful links
Usage
This library has been created to implement generation of OpenAPI Documentation
in the BlackSheep
web framework.
This package contains only parts that belong logically to the OpenAPI specification,
and can be reused for other applications.
Limitations
- Partial support for Parameter properties:
style
,allow_reserved
,explode
are not handled - Doesn't implement an API to handle specification extensions out of the box, however it enables modifying generated objects before they are serialized
- 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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.