iglo

package module
v0.0.0-...-4c66e84 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2013 License: MIT Imports: 10 Imported by: 0

README

iglo

API blueprint's formatter.

Build Status

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

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

$ cd examples
$ go run api-server.go

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

Or, you can just visit this demo page :)

Dependencies

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Tmpl = `` /* 4704-byte string literal not displayed */

Functions

func HTML 

func HTML(w io.Writer, api *API) error

func JSONToHTML 

func JSONToHTML(w io.Writer, r io.Reader) error

func MarkdownToHTML 

func MarkdownToHTML(w io.Writer, r io.Reader) error

func ParseMarkdown 

func ParseMarkdown(r io.Reader) ([]byte, error)

Types

type API 

type API struct {
	Version        string          `json:"_version"`
	Name           string          `json:"name"`
	Description    string          `json:"description"`
	Metadata       Metadata        `json:"metadata"`
	ResourceGroups []ResourceGroup `json:"resourceGroups"`
}

func ParseJSON 

func ParseJSON(r io.Reader) (*API, error)

type Action 

type Action struct {
	Name        string               `json:"name"`
	Description string               `json:"description"`
	Method      string               `json:"method"`
	Parameters  map[string]Parameter `json:"parameters"`
	Headers     map[string]Header    `json:"headers"`
	Examples    []Example            `json:"examples"`
}

type Example 

type Example struct {
	Name        string     `json:"name"`
	Description string     `json:"description"`
	Requests    []Request  `json:"requests"`
	Responses   []Response `json:"responses"`
}

type Format 

type Format struct {
	Value string `json:"value"`
}
type Header struct {
	Value string `json:"value"`
}

type Host 

type Host struct {
	Value string `json:"value"`
}

type Metadata 

type Metadata struct {
	Format Format `json:"FORMAT"`
	Host   Host   `json:"HOST"`
}

type Model 

type Model struct {
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Headers     map[string]Header `json:"headers"`
	Body        string            `json:"body"`
	Schema      string            `json:"schema"`
}

type Parameter 

type Parameter struct {
	Description string   `json:"description"`
	Type        string   `json:"type"`
	Required    bool     `json:"required"`
	Default     string   `json:"default"`
	Example     string   `json:"example"`
	Values      []string `json:"values"`
}

type Request 

type Request struct {
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Headers     map[string]Header `json:"headers"`
	Body        string            `json:"body"`
	Schema      string            `json:"schema"`
}

type Resource 

type Resource struct {
	Name        string               `json:"name"`
	Description string               `json:"description"`
	UriTemplate string               `json:"uriTemplate"`
	Model       Model                `json:"model"`
	Parameters  map[string]Parameter `json:"parameters"`
	Headers     map[string]Header    `json:"headers"`
	Actions     []Action             `json:"actions"`
}

type ResourceGroup 

type ResourceGroup struct {
	Name        string     `json:"name"`
	Description string     `json:"description"`
	Resources   []Resource `json:"resources"`
}

type Response 

type Response struct {
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Headers     map[string]Header `json:"headers"`
	Body        string            `json:"body"`
	Schema      string            `json:"schema"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
JackTT - Gopher 🇻🇳