apigen

Documentation

Index

• type API
  • func New(version, description string) *API
  • func (a *API) Group(name, prefix string) *EndpointGroup
• type Endpoint
  • func (e *Endpoint) APIAuth() bool
  • func (e *Endpoint) CookieAuth() bool
• type EndpointGroup
  • func (eg *EndpointGroup) Get(path string, endpoint *Endpoint)
• type PathMethod

Types

type API

type API struct {
	Version        string
	Description    string
	EndpointGroups []*EndpointGroup
}

API represents specific API's configuration.

func New

func New(version, description string) *API

New creates new API with specific configuration.

func (*API) Group

func (a *API) Group(name, prefix string) *EndpointGroup

Group adds new endpoints group to API.

type Endpoint

type Endpoint struct {
	Name         string
	Description  string
	MethodName   string
	NoCookieAuth bool
	NoAPIAuth    bool
	Request      interface{}
	Response     interface{}
	Params       []string
}

Endpoint represents endpoint's configuration.

func (*Endpoint) APIAuth

func (e *Endpoint) APIAuth() bool

APIAuth returns endpoint's API auth status.

func (*Endpoint) CookieAuth

func (e *Endpoint) CookieAuth() bool

CookieAuth returns endpoint's cookie auth status.

type EndpointGroup

type EndpointGroup struct {
	Name      string
	Prefix    string
	Endpoints map[PathMethod]*Endpoint
}

EndpointGroup represents endpoints group.

func (*EndpointGroup) Get

func (eg *EndpointGroup) Get(path string, endpoint *Endpoint)

Get adds new GET endpoint to endpoints group.

type PathMethod

type PathMethod struct {
	Path   string
	Method string
}

PathMethod represents endpoint's path and method type.