api

package

v0.0.0-...-3d294e8 Latest Latest Go to latest Published: Apr 5, 2019 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package api implements reflection based http.Handler generation.

This section is empty.

This section is empty.

This section is empty.

type API struct {
	Router        *httprouter.Router
	Documentation *apidoc.Documentation
	// contains filtered or unexported fields
}

func New(info *apidoc.Info, authorize AuthorizationHandler) *API

func (api *API) Add(op *apidoc.Operation, fn interface{})

type AuthorizationHandler func(w http.ResponseWriter, r *http.Request) (string, error)

type Params struct {
	// contains filtered or unexported fields
}

func (p *Params) Boolean(name string) (bool, bool)

func (p *Params) Integer(name string) (int, bool)

func (p *Params) Number(name string) (float64, bool)

func (p *Params) String(name string) (string, bool)

type Request struct {
	// contains filtered or unexported fields
}

func (r *Request) PathParam() *Params

func (r *Request) QueryParam() *Params

func (r *Request) Username() string

type RequestBuilder struct {
	// contains filtered or unexported fields
}

RequestBuilder simplifies the creation of api Requests for testing.

func NewRequest(username string) *RequestBuilder

func (b *RequestBuilder) Build() *Request

func (b *RequestBuilder) PathInteger(name string, value int) *RequestBuilder