This is a parser for API Blueprint files in PHP.1
Requires PHP 5.6+ to run. Unittests require runkit or uopz For direct usage you can run:
$ ./phpdraft.phar -f blueprint-file.apib > blueprint-webpage.htmlYou can also install it first:
$ cp phpdraft.phar /usr/bin/phpdraft
$ chmod +x /usr/bin/phpdraft
$ phpdraft -f blueprint-file.apib > blueprint-webpage.htmlWe got some fun stuff, check the wiki for more.
For writing API documentation using API Blueprint syntax. You can read about its specification.
Here's the example:
FORMAT: 1A
HOST: https://api.example.com/v1
# Hello API
A simple API demo
# Group People
This section describes about the People
## Person [/people/{id}]
Represent particular Person
+ Parameters
+ id (required, string, `123`) ... The id of the Person.
+ Model (application/json)
```
{"name":"Gesang","birthdate":"01-09-1917"}
```
### Retrieve Person [GET]
Return the information for the Person
+ Request (application/json)
+ Headers
```
Authorization: Basic AbcdeFg=
```
+ Response 200 (application/json)
[Person][]
PHPDraft requires drafter to be installed. Refer to the drafter page for the installation details.
Install phpab and put it in your path.
Run ant phar or ant phar-nightly
This app usage the following libraries: