This is a Python script that generates API documentation from an OpenAPI specification file.
- Python 3.x
- json
- PyYAML
- openapi-core
- Jinja2
pip install -r requirement.txt
install a project in editble mode
pip install -e ./
run tests - not unit tests
python tests/test.py
from openapi_markdown.generator import to_markdown
apiFile = "./tests/openapi.json"
outputFile = "api_doc.md"
to_markdown(apiFile, outputFile)python3 -m pip install --upgrade twine
./pypi.sh