Skip to content

owainlewis/apidoc

Repository files navigation

API DOC

Generate professional looking, human readable documentation from Swagger.

A demo can be found here

Currently this only supports Swagger YAML format, but RAML will be next. You can quickly customize any of the templates.

Simply drop your Swagger specs in static/specs and off you go :)

Getting Started

This app can use either Python 2 or 3 and is pretty much a standard Flask application.

# Install deps
sudo apt-get install python3-pip
pip3 install -r requirements.txt
# Run it
python3 app.py
# Visit localhost:5000

Update the templates or stylesheets to suite your needs.

Deploy to Heroku

heroku create mydocs
git push heroku master

License

MIT License

About

Generate professional looking, human readable documentation from Swagger or RAML

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published