Documentation

Overview

    Package gendoc generates documentation for REST APIs.

    Index

    Constants

    View Source
    const (
    	TypeArray  = "array"
    	TypeBool   = "boolean"
    	TypeFloat  = "float"
    	TypeInt    = "integer"
    	TypeObject = "object"
    	TypeString = "string"
    )
    View Source
    const CodeDefault = 0

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type Document

    type Document struct {
    	Title       string
    	Description string
    	Version     string
    	Paths       []Path
    	Models      []Schema
    }

    func ParseGoogleAPI

    func ParseGoogleAPI(r io.Reader) (Document, error)

    func (Document) MarshalMarkdown

    func (doc Document) MarshalMarkdown() ([]byte, error)

    type Parameter

    type Parameter struct {
    	Name        string
    	LocatedIn   string
    	Description string
    	Required    bool
    	Type        string
    }

    type Path

    type Path struct {
    	Method      string
    	Path        string
    	Summary     string
    	Description string
    	Parameters  []Parameter
    	Responses   []Response
    }

    type Response

    type Response struct {
    	Code        int // 0 means "Default"
    	Description string
    	Type        string
    }

    type Schema

    type Schema struct {
    	Name        string
    	Type        string
    	Description string
    	Children    []Schema
    	Ref         string
    }