Apidoc is an open specification for documenting REST APIs in JSON or YAML. Imperfect as it is, it’s de facto a standard for many API developers.
This extension lets you render your swagger.json file as a Markdown document. You can customize the output by providing your own Jinja2 template.
Installation
$ pip install apidoc2markdownUsage
usage: apidoc2markdown-script.py [-h] [-i APIDOC_LOCATION] [-o OUTPUT]
[-t TEMPLATE]
optional arguments:
-h, --help show this help message and exit
-i APIDOC_LOCATION, --input APIDOC_LOCATION
path to the directory with api_data.json
and api_project.json (default: .)
-o OUTPUT, --output OUTPUT
path to the output Markdown file (default: swagger.md)
-t TEMPLATE, --template TEMPLATE
Jinja2 template used for conversion1 maintainer
Metadata
1 maintainer
Release files for apidoc2markdown 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| apidoc2markdown-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / apidoc2markdown-0.1.0-py3-none-any.whl
| Download URL | apidoc2markdown-0.1.0-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2751a623c53a3142915226ad9b01641a63a8cdd342c65e13c8ace89c31487889
|
|
BLAKE2b-256 checksum How to use checksums |
d7ab7fcf4a51183d309f00bf63cf04de113f5198043dea14a977d2215f8620da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for apidoc2markdown 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
