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.0.1.tar.gz
(9.3 kB
view hashes)
Built Distribution
Close
Hashes for AutoOpenApi-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3c0fc032c9e777f54cb4b7a210cb224a1dfef0f0112742862c4c3f7223eb39c |
|
MD5 | 63ba779eb8b9437ece46372a80c07e45 |
|
BLAKE2b-256 | 46dc167b69ea2688a012ef2ad3157c0b74465a5b334075314fea73d920eb7e00 |