Switch branches/tags
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
example
README.md
api.css
apidoc

README.md

REST API documentation generator

About

This script helps to generate an REST API documentation (in HTML) using a small DSL.

Example

Some examples are available in the examples/ directory.

To generate the documentation of this examples:

./apidoc 'Kadeploy/3.2 REST API specifications' \
	api.css example/*.apidoc > kadeploy_3.2-specs.html

The generated web page of this example can be seen here.