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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file apihero-0.1.3.tar.gz
.
File metadata
- Download URL: apihero-0.1.3.tar.gz
- Upload date:
- Size: 91.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d7552d539576cb24837f33e8901c5d821a8c967cba4f3a20cb49158ca49650c |
|
MD5 | 338ed184430fd9881b292301539a5239 |
|
BLAKE2b-256 | 5a0f6359db502d91f019c6a3076da77f249a363f7bdb1c74ab040c9683217d03 |