apihero

RESTful JSON API documentation generator tool with live unit test.


Keywords
apihero, api_documentation, api, document_generator
License
GPL-3.0
Install
pip install apihero==0.1.3

Documentation

https://github.com/meyt/apihero/raw/master/apihero-logo-128.png

APIHero

RESTful JSON API documentation generator tool with live unit test. Demo

  • Live test unit.
  • File based structure.
  • Template support (Based on Mako).
  • Formatting with JSON and Markdown.

How to use

install from pip:

sudo pip install apihero

just work on python3, and if doesn't work on distros like ubuntu

sudo apt install python3-pip
sudo pip3 install apihero

Now checkout APIHero sample and learn how to create your own documentation. for build output cd on your documentation directory and simply run apihero.

TODO

  • Localization support.
  • Be template design easier.
  • External pages.
  • Search.
  • Response syntax highlighting.
  • Single-page build.
  • Add remember option for parameters, to keep last value.
  • Pre-loader for test unit.
  • Complete APIHero documentation.
  • Add configurable CLI argument's.
  • Add one level category.