Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

RESTful JSON API documentation generator tool with live unit test.

Project Description

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.

Release History

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
apihero-0.1.3.tar.gz
(91.7 kB) Copy SHA256 Hash SHA256
Source None Nov 25, 2016

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting