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
1 maintainer
Release files for AutoOpenApi 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| AutoOpenApi-1.2.0.tar.gz | 9.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| AutoOpenApi-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.7 kB
Release files / AutoOpenApi-1.2.0.tar.gz
| Download URL | AutoOpenApi-1.2.0.tar.gz |
|---|---|
| Size | 9.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34f46809a0fc211ffff3687a0e108269b047a77d90c64a17169ba11db1540d9e
|
|
BLAKE2b-256 checksum How to use checksums |
2d1006cdf99dcc10528f804f44992d36a1659ff193ca84f7374a4f1ad86a05ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / AutoOpenApi-1.2.0-py3-none-any.whl
| Download URL | AutoOpenApi-1.2.0-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
814f715bfcadf32e0f4479ed2c8661bb912fb5a23b53268a0068ae970a1bd340
|
|
BLAKE2b-256 checksum How to use checksums |
4b6db3d080e07a2f58ae8c296717afa8cb4b42aeba5fe6ed24ce66df5f5efc01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
