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.1.0.tar.gz
(5.0 kB
view hashes)
Built Distribution
Close
Hashes for openapi_markdown-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10f0677e62ed134d3256303aad4d848ee129337cc614b9e91b213ca737f6fb18 |
|
MD5 | fb4e7cc0f0bcbb2378581cfbc314aef0 |
|
BLAKE2b-256 | de14d7f7370996954dc09992f4ea448891530e3e53ddddf56c27cf269e5b0172 |