API blueprint's formatter.
For writing API documentation, the iglo 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][]
Make sure you have iglo installed in the GOPATH
$ cd $GOPATH
$ go get github.com/subosito/igloYou can go to the examples directory and then run the api-server.go.
$ cd examples
$ go run api-server.goThen visit http://localhost:8080/ to see the output.
Or, you can just visit this demo page :)
The iglo ParseMarkdown requires snowcrash to be installed. Refer to the snowcrash page for the installation details.