Skip to main content

REST APIs documentation builder tool

Project description

RESTful api documentation generation script
===================

script to generate restful api documentation out of annotated php code. [Output example you can find here](http://htmlpreview.github.io/?https://raw.github.com/dzhibas/rest-api-doc/master/documentation.html)

annotation example

/**
* @route /v1/modulename/authentication
* @method POST
* @ingroup modulename
*
* authentication service example
*
* HTTP response code tells about status of login:
*
* - 202: Request Accepted
* - 401: Invalid username/password
* - 403: Request Denied
* - 503: Service Unavailable
*
* @example input
*
* POST /v1/modulename/authentication HTTP/1.1
* Content-Type: application/json; charset=utf-8
*
* {
* "username": "demousername",
* "passwrod": "demopassword",
* }
*
* @example output
*
* {
* "message":"Request Accepted",
* "id":386
* }
*
* @jsonparam username extranet username required
* @jsonparam password extranet password required
*
* @returns json
*/

Installation
==
pip install -r requirements.txt

Usage
==
$ python parse.py -c

Help
==
usage: parse.py [-h] [-c] [-d DIR] [--filter FILTER] [-o OUTPUT]

optional arguments:
-h, --help show this help message and exit
-c, --coverage ouputs into stdin documentation coverage
-d DIR, --dir DIR folder in which we need look for documentation
annotation. default: test_src_folder/
--filter FILTER gob filter in which files to search. default:
*Controler*.php
-o OUTPUT, --output OUTPUT
output filename. default: documentation.html

open generated documentation.html

Project details


Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

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
restapidoc-0.1.2.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None Aug 30, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page