api

Documentation

Index

• Constants
• Variables
• type API
  • func (c *API) ToJSONRPC(validateSettings *services.ValidateSettings) (jsonrpc.Handler, error)
  • func (c *API) ToREST(validateSettings *services.ValidateSettings) (rest.Handler, error)
• type APIDocParams
• type Endpoint
• type Method
• type REST
• type ReturnType
  • func (r *ReturnType) MarshalJSON() ([]byte, error)

Constants

const (
	POST   = Method("POST")
	GET    = Method("GET")
	PUT    = Method("PUT")
	DELETE = Method("DELETE")
	PATCH  = Method("PATCH")
)

Variables

var APIDocForm = &forms.Form{}

Types

type API

type API struct {
	Name        string      `json:"name"`
	Version     int         `json:"version"`
	Description string      `json:"description"`
	Endpoints   []*Endpoint `json:"endpoints"`
}

func (*API) ToJSONRPC

func (c *API) ToJSONRPC(validateSettings *services.ValidateSettings) (jsonrpc.Handler, error)

func (*API) ToREST

func (c *API) ToREST(validateSettings *services.ValidateSettings) (rest.Handler, error)

type APIDocParams

type APIDocParams struct {
}

type Endpoint

type Endpoint struct {
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Handler     interface{} `json:"-"`
	REST        *REST       `json:"rest,omitempty"`
	Form        *forms.Form `json:"form"`
	ReturnType  *ReturnType `json:"returnType"`
}

type Method

type Method string

type REST

type REST struct {
	Path   string `json:"path"`
	Method Method `json:"method"`
}

type ReturnType

type ReturnType struct {
	Validators []forms.Validator
}

func (*ReturnType) MarshalJSON

func (r *ReturnType) MarshalJSON() ([]byte, error)