Skip to content
This repository has been archived by the owner on Jan 5, 2019. It is now read-only.

meyt/apihero

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

image

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.
  • Automatic build through file wather.
  • Add simple raw response body.
  • Resend request on result popup.

About

RESTful JSON API documentation generator tool with live unit test.

Resources

License

Stars

Watchers

Forks

Packages

No packages published