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
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
openapi_markdown-0.0.2.tar.gz
(3.9 kB
view hashes)
Built Distribution
Close
Hashes for openapi_markdown-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fefefc53b4081c8595ae4c73142d1f46a92ea6f683711065d2ee37e7a9f326c |
|
MD5 | 81a8cbf49881c1e8f4639291484c53a3 |
|
BLAKE2b-256 | 1ca703ce36ba021c95b9456917d43340dbbb510bc179bd916c4cf319549c3032 |