Help us shape the future of Go! Take the 2026 Go Developer Survey

describe

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Nov 3, 2016 License: Unlicense Imports: 2 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Body

type Body struct {
	ContentType string
	Format      string
}

type Method

type Method struct {
	Method      string
	Description string
	Requests    []Request
}

type Parameter

type Parameter struct {
	Name        string
	Type        string
	Description string
	Required    bool
	Format      string
	Regexp      *regexp.Regexp
	Examples    []string
}

type Request

type Request struct {
	Name            string
	Description     string
	Headers         []Parameter
	PathParameters  []Parameter
	QueryParameters []Parameter
	Body            Body
	Successes       []Response
	Failures        []Response
}

type Response

type Response struct {
	Name        string
	Description string
	StatusCode  int
	Headers     []Parameter
	Fields      []Parameter
	ErrorCodes  []errcode.ErrorCode
	Body        Body
}

type Route

type Route struct {
	Name        string
	Path        string
	Entity      string
	Description string
	Methods     []Method
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL