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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file AutoOpenApi-1.2.0.tar.gz.
File metadata
- Download URL: AutoOpenApi-1.2.0.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
34f46809a0fc211ffff3687a0e108269b047a77d90c64a17169ba11db1540d9e
|
|
| MD5 |
9b0af23f0bfab8888487d30a9109cbb6
|
|
| BLAKE2b-256 |
2d1006cdf99dcc10528f804f44992d36a1659ff193ca84f7374a4f1ad86a05ba
|
File details
Details for the file AutoOpenApi-1.2.0-py3-none-any.whl.
File metadata
- Download URL: AutoOpenApi-1.2.0-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
814f715bfcadf32e0f4479ed2c8661bb912fb5a23b53268a0068ae970a1bd340
|
|
| MD5 |
f08dd13caed4de3dd6bd663405cab943
|
|
| BLAKE2b-256 |
4b6db3d080e07a2f58ae8c296717afa8cb4b42aeba5fe6ed24ce66df5f5efc01
|
