• Stars
    star
    332
  • Rank 126,993 (Top 3 %)
  • Language
    Go
  • License
    MIT License
  • Created about 11 years ago
  • Updated about 8 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

API blueprint's formatter

iglo

API blueprint's formatter.

Build Status

Status

DEPRECATED. Please use https://github.com/subosito/snowboard instead.

Writing API documentation

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][]

Demo

Make sure you have iglo installed in the GOPATH

$ cd $GOPATH
$ go get github.com/subosito/iglo

Serving as HTTP

You can go to the examples/api-server directory and then run the main.go.

$ cd examples/api-server
$ go run main.go

Then visit http://localhost:8080/ to see the output.

Or, you can just visit this demo page :)

Exporting as HTML file

You can go to the examples/api-exporter directory and then run the main.go.

$ cd examples/api-exporter
$ go run main.go -out "api-output.html"

Now you have HTML generated output in the api-output.html.

Dependencies

The iglo ParseMarkdown requires drafter to be installed. Refer to the drafter page for the installation details.

Related Projects

More Repositories

1

flutter-action

Flutter environment for use in GitHub Actions. It works on Linux, Windows, and macOS.
Shell
2,163
star
2

gingerice

Ruby wrapper for correcting spelling and grammar mistakes based on the context of complete sentences.
Ruby
481
star
3

gotenv

Load environment variables from `.env` or `io.Reader` in Go.
Go
282
star
4

shorturl

Generic implementation for interacting with various URL shortening services in Go.
Go
85
star
5

twilio

Simple Twilio API wrapper in Go
Go
72
star
6

mascherano

Capistrano 3.x recipes
Ruby
39
star
7

audiojs-rails

AudioJS on rails asset pipeline
Ruby
23
star
8

openshift-ruby

Redhat's Openshift runs Ruby 2.0
Ruby
20
star
9

sixpack-go

Go client library for SeatGeek's Sixpack AB testing framework.
Go
19
star
10

gozaru

Filename sanitization for Go
Go
5
star
11

confreaks

confreaks on the command line
Go
5
star
12

simple_gravatar

Gravatar library for Dart 2
Dart
5
star
13

bootstrap-sass-rtl-rails

RTL version of bootstrap-sass
Ruby
4
star
14

gpaste-menu

dmenu + gpaste-client
Shell
4
star
15

tiffany

Go vanity URL
Go
3
star
16

plur

Opinionated development workflow and commonly used tools for Ruby on Rails based development.
Ruby
3
star
17

rails-openshift-action-hooks

Custom action hooks for rails deployment on openshift DIY
Shell
1
star
18

subosito.github.io

~
1
star
19

vscd

Visual Studio Code customization tool
JavaScript
1
star
20

gsapi

go-search.org api
Go
1
star
21

image64

Convert an image to base64 data URI scheme
Go
1
star
22

shorticon

A simple package for fetching a website's favicon.
Go
1
star
23

dropbox-light-icons

Dropbox status icons for dark panel.
Shell
1
star
24

flutter-action-example

Test cases for flutter-action
1
star