Skip to main content
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.

Metadata

Release files for apihero 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apihero 0.1.3
File Size Uploaded
apihero-0.1.3.tar.gz 91.7 kB Details

Release files / apihero-0.1.3.tar.gz

Download URL apihero-0.1.3.tar.gz
Size 91.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0d7552d539576cb24837f33e8901c5d821a8c967cba4f3a20cb49158ca49650c
BLAKE2b-256 checksum
How to use checksums
5a0f6359db502d91f019c6a3076da77f249a363f7bdb1c74ab040c9683217d03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.3 This release

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page