doc

Documentation

Index

• Constants
• func CopyHeader(dst, src http.Header)
• type Action
  • func NewAction(method, handlerName string) (*Action, error)
  • func (a *Action) AddRequest(req *Request, resp *Response)
  • func (a *Action) Render() string
• type Body
  • func NewBody(content []byte, contentType string) (b *Body)
  • func (b *Body) FormattedJSON() string
  • func (b *Body) FormattedStr() string
  • func (b *Body) Render() string
• type Doc
  • func NewDoc(pkgDir string) (doc *Doc, err error)
  • func (d *Doc) AddResource(resource *Resource)
  • func (d *Doc) Write() error
• type HTTPMethod
• type Header
  • func NewHeader(h http.Header) *Header
  • func (h Header) Render() string
• type Metadata
• type Parameter
  • func MakeParameter(key, val string) Parameter
  • func (p *Parameter) Render() string
• type ParameterType
  • func (pt ParameterType) String() string
• type ParameterValue
  • func (val ParameterValue) Quote() (qval string)
• type Request
  • func NewRequest(req *http.Request) (*Request, error)
  • func (r *Request) HasBody() bool
  • func (r *Request) HasContentType() bool
  • func (r *Request) HasHeader() bool
  • func (r *Request) Render() string
• type Resource
  • func NewResource(u *URL) *Resource
  • func (r *Resource) AddAction(action *Action)
  • func (r *Resource) FindAction(httpMethod string) *Action
  • func (r *Resource) Render() string
• type ResourceGroup
  • func (rg *ResourceGroup) Render() string
• type Response
  • func NewResponse(resp *httptest.ResponseRecorder) *Response
  • func (r *Response) HasContentType() bool
  • func (r *Response) Render() string
• type URL
  • func NewURL(req *http.Request) *URL

Constants

const (
	TitleHeader       = "X-Test2Doc-Title"
	DescriptionHeader = "X-Test2Doc-Description"
	FilterHeader      = "X-Test2Doc-Filter"
)

Functions

func CopyHeader

func CopyHeader(dst, src http.Header)

Types

type Action

type Action struct {
	Title       string
	Description string
	Method      HTTPMethod
	Requests    []*Request
}

func NewAction

func NewAction(method, handlerName string) (*Action, error)

func (*Action) AddRequest

func (a *Action) AddRequest(req *Request, resp *Response)

func (*Action) Render

func (a *Action) Render() string

type Body

type Body struct {
	Content     []byte
	ContentType string
}

func NewBody

func NewBody(content []byte, contentType string) (b *Body)

func (*Body) FormattedJSON

func (b *Body) FormattedJSON() string

func (*Body) FormattedStr

func (b *Body) FormattedStr() string

func (*Body) Render

func (b *Body) Render() string

type Doc

type Doc struct {
	Group ResourceGroup
	// contains filtered or unexported fields
}

func NewDoc

func NewDoc(pkgDir string) (doc *Doc, err error)

func (*Doc) AddResource

func (d *Doc) AddResource(resource *Resource)

TODO: add Resource to appropriate ResourceGroup,

not just to ResourceGroups[0]

func (*Doc) Write

func (d *Doc) Write() error

type HTTPMethod

type HTTPMethod string

type Header

type Header struct {
	DisplayHeader http.Header
	ContentType   string
}

func NewHeader

func NewHeader(h http.Header) *Header

func (Header) Render

func (h Header) Render() string

type Metadata

type Metadata struct {
	Format string
	Host   string
}

type Parameter

type Parameter struct {
	Name        string
	Description string
	Value       ParameterValue
	Type        ParameterType
	IsRequired  bool
}

func MakeParameter

func MakeParameter(key, val string) Parameter

func (*Parameter) Render

func (p *Parameter) Render() string

type ParameterType

type ParameterType int

const (
	Number ParameterType = iota
	String
	Boolean
)

func (ParameterType) String

func (pt ParameterType) String() string

type ParameterValue

type ParameterValue string

func (ParameterValue) Quote

func (val ParameterValue) Quote() (qval string)

type Request

type Request struct {
	Header   *Header
	Body     *Body
	Method   string
	Response *Response

	Title       string
	Description string
}

func NewRequest

func NewRequest(req *http.Request) (*Request, error)

func (*Request) HasBody

func (r *Request) HasBody() bool

func (*Request) HasContentType

func (r *Request) HasContentType() bool

func (*Request) HasHeader

func (r *Request) HasHeader() bool

func (*Request) Render

func (r *Request) Render() string

type Resource

type Resource struct {
	Title       string
	Description string
	//Model       *Model
	URL     *URL
	Actions map[HTTPMethod]*Action
}

func NewResource

func NewResource(u *URL) *Resource

NewResource returns a new Resource object

func (*Resource) AddAction

func (r *Resource) AddAction(action *Action)

func (*Resource) FindAction

func (r *Resource) FindAction(httpMethod string) *Action

func (*Resource) Render

func (r *Resource) Render() string

type ResourceGroup

type ResourceGroup struct {
	Title       string
	Description string
	Resources   []Resource
}

func (*ResourceGroup) Render

func (rg *ResourceGroup) Render() string

type Response

type Response struct {
	StatusCode  int
	Description string
	Header      *Header
	Body        *Body
}

func NewResponse

func NewResponse(resp *httptest.ResponseRecorder) *Response

func (*Response) HasContentType

func (r *Response) HasContentType() bool

func (*Response) Render

func (r *Response) Render() string

type URL

type URL struct {
	ParameterizedPath string
	Parameters        []Parameter
	// contains filtered or unexported fields
}

func NewURL

func NewURL(req *http.Request) *URL