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.

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 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


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-0.1.2.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

essentials_openapi-0.1.2-py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 3

Supported by

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