Skip to main content

An attempt to go from test definition to openapi3 spec

Project description

AutoOpenApi

Is an attempt to automate the production of API documentation. This library attempts to build API documentation to OpenApi3 Specification.

It does this based on the tests defined, in your project. In order to generate your API documentation you need to do the following:

  • 1. Install the library
  • 2. Put a .yaml file in your tests/ dir
  • 3. import the package: from AutoOpenApi.autoopenapi import ToDoc
  • 4. include a call to build an endpoint in the tests you wish to have included: ToDoc(your_input_file, your_output_file).build_endpoint(event=your_event, response=your_response)
  • 5. Run the tests

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

AutoOpenApi-1.1.0.tar.gz (9.3 kB view hashes)

Uploaded Source

Built Distribution

AutoOpenApi-1.1.0-py3-none-any.whl (7.2 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