Generates API documentation from an OpenAPI specification file
Project description
OpenAPI Documentation Generator
This is a Python script that generates API documentation from an OpenAPI specification file.
Requirements
- Python 3.x
- json
- PyYAML
- openapi-core
- Jinja2
Development
pip install -r requirement.txt
install a project in editble mode
pip install -e ./
run tests - not unit tests
python tests/test.py
Usage
from openapi_markdown.generator import to_markdown
apiFile = "./tests/openapi.json"
outputFile = "api_doc.md"
to_markdown(apiFile, outputFile)
Deploy
python3 -m pip install --upgrade twine
./pypi.sh
Release history Release notifications | RSS feed
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
File details
Details for the file openapi_markdown-0.2.0.tar.gz.
File metadata
- Download URL: openapi_markdown-0.2.0.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 47140ee41fac138530b2aa8a2875fe6c0cff81d95b8e3d051b1cd922228e3174 |
|
| MD5 | 378acb105d1589543bf3664b70123794 |
|
| BLAKE2b-256 | 55fe57bdefb0de1b9a8323866dcec68b8c1698e02f4b5073e9a086ab51eab9de |
File details
Details for the file openapi_markdown-0.2.0-py3-none-any.whl.
File metadata
- Download URL: openapi_markdown-0.2.0-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce885d2add5258f6187fd3d5265805c3adff6b4e8a4c88f95516652cc67eb939 |
|
| MD5 | 46b1999eb2f4d82da92c80d25d5d86c8 |
|
| BLAKE2b-256 | bff2f699d39817c51a9b1ef5be2723552a856f7ac58b00254842f3292023cf97 |
