rest

package module

Go to main page

Versions in this module

v0

v0.8.7

Dec 19, 2020

v0.8.6

Dec 16, 2020

v0.8.5

Dec 14, 2020

v0.8.4

Dec 14, 2020

v0.8.3

Dec 14, 2020

v0.8.2

Dec 14, 2020

v0.8.1

Dec 14, 2020

v0.8.0

Dec 11, 2020

Changes in this version

+ type ErrorAuthentication struct

+ Message string

+ func (ia ErrorAuthentication) Error() string

+ type ErrorAuthorization struct

+ Message string

+ func (ia ErrorAuthorization) Error() string

+ type ErrorFailResponseNotDefined struct

+ Name string

+ func (e *ErrorFailResponseNotDefined) Error() string

+ type ErrorGetURIParamFunctionNotDefined struct

+ Name string

+ func (e *ErrorGetURIParamFunctionNotDefined) Error() string

+ type ErrorParameterCharNotAllowed struct

+ Name string

+ func (e *ErrorParameterCharNotAllowed) Error() string

+ type ErrorParameterNotDefined struct

+ Name string

+ func (e *ErrorParameterNotDefined) Error() string

+ type ErrorResourceCharNotAllowed struct

+ Name string

+ func (e *ErrorResourceCharNotAllowed) Error() string

v0.7.0

Dec 10, 2020

Changes in this version

type Resource

+ func NewResourceP(p Parameter) Resource

type ResourceCollection

+ func (rs *ResourceCollection) ResourceP(p Parameter, fn func(r *Resource))

v0.6.0

Dec 10, 2020

Changes in this version

+ const ResourceReservedChar

+ const URIReservedChar

type Resource

+ func NewResourceParam(p Parameter) Resource

type ResourceCollection

+ func (rs *ResourceCollection) ResourceParam(p Parameter, fn func(r *Resource))

+ type TypeErrorParameterCharNotAllowed struct

+ func (e *TypeErrorParameterCharNotAllowed) Error() string

+ type TypeErrorResourceCharNotAllowed struct

+ func (e *TypeErrorResourceCharNotAllowed) Error() string

v0.5.1

Dec 8, 2020

v0.5.0

Dec 7, 2020

Changes in this version

type Method

+ func (m *Method) OverwriteCoreSecurityMiddleware(mid Middleware) *Method

type Resource

+ func (rs *Resource) OverwriteCoreSecurityMiddleware(m Middleware)

v0.4.0

Dec 3, 2020

Changes in this version

+ type Middleware func(http.Handler) http.Handler

type Resource

+ func (rs *Resource) Use(m ...Middleware)

v0.3.0

Dec 1, 2020

Changes in this version

type Method

+ SecurityCollection []Security

type Security

+ SecuritySchemes []*SecurityScheme

+ type SecurityOption func(*Security)

+ func AddScheme(scheme *SecurityScheme) SecurityOption

+ func Enforce() SecurityOption

+ type SecurityScheme struct

+ Description string

+ Name string

+ OAuth2Flows []OAuth2Flow

+ Parameter Parameter

+ Type string

+ func NewAPIKeySecurityScheme(name string, p Parameter, securityOperation SecurityOperation) *SecurityScheme

+ func NewOAuth2SecurityScheme(name string, securityOperation SecurityOperation) *SecurityScheme

+ func NewSecurityScheme(name string, securityType string, securityOperation SecurityOperation) *SecurityScheme

+ func (s *SecurityScheme) WithAuthCodeOAuth2Flow(authorizationURL, tokenURL string, scopes map[string]string) *SecurityScheme

+ func (s *SecurityScheme) WithClientCredentialOAuth2Flow(tokenURL string, scopes map[string]string) *SecurityScheme

+ func (s *SecurityScheme) WithImplicitOAuth2Flow(authorizationURL string, scopes map[string]string) *SecurityScheme

+ func (s *SecurityScheme) WithOAuth2Flow(flow OAuth2Flow) *SecurityScheme

+ func (s *SecurityScheme) WithPasswordOAuth2Flow(tokenURL string, scopes map[string]string) *SecurityScheme

v0.2.0

Nov 25, 2020

Changes in this version

+ type ContentTypes struct

+ UnsupportedMediaTypeResponse Response

+ func NewContentTypes() ContentTypes

+ func (h *ContentTypes) Add(mimeType string, ed encdec.EncoderDecoder, isDefault bool)

+ func (h *ContentTypes) AddDecoder(mimeType string, decoder encdec.Decoder, isDefault bool)

+ func (h *ContentTypes) AddEncoder(mimeType string, encoder encdec.Encoder, isDefault bool)

+ func (h *ContentTypes) GetDecoder(mimeType string) (encdec.Decoder, error)

+ func (h *ContentTypes) GetDefaultDecoder() (string, encdec.Decoder, error)

+ func (h *ContentTypes) GetDefaultEncoder() (string, encdec.Encoder, error)

+ func (h *ContentTypes) GetEncoder(mimeType string) (encdec.Encoder, error)

v0.1.0

Nov 20, 2020

Changes in this version

+ type Validation struct

+ Response Response

v0.0.1

Nov 19, 2020

v0.0.0

Nov 16, 2020

Changes in this version

+ const APIKeySecurityType

+ const BasicSecurityType

+ const FlowAuthCodeType

+ const FlowClientCredentialType

+ const FlowImplicitType

+ const FlowPasswordType

+ const OAuth2SecurityType

+ var ErrorNoDefaultContentTypeIsSet = errors.New("no default renderer is set")

+ var ErrorRequestBodyNotDefined = errors.New("rest: a request body was not defined")

+ type API struct

+ BasePath string

+ Description string

+ Host string

+ ID string

+ Title string

+ Version string

+ func NewAPI(basePath, host, title, version string) API

+ func (a API) GenerateServer(serverGenerator ServerGenerator) http.Handler

+ func (a API) GenerateSpec(writer io.Writer, specGenerator APISpecGenerator)

+ type APISpecGenerator interface

+ GenerateAPISpec func(w io.Writer, api API)

+ type AuthError interface

+ Error func() string

+ type Authenticator interface

+ Authenticate func(Input) AuthError

+ type AuthenticatorFunc func(Input) AuthError

+ func (f AuthenticatorFunc) Authenticate(i Input) AuthError

+ type CollectionParam struct

+ CollectionFormat string

+ EnumValues []interface{}

+ type ContentTypeContextKey string

+ type DefaultNegotiator struct

+ func (d DefaultNegotiator) NegotiateDecoder(r *http.Request, cts *Renderers) (string, encdec.Decoder, error)

+ func (d DefaultNegotiator) NegotiateEncoder(r *http.Request, cts *Renderers) (string, encdec.Encoder, error)

+ type EncoderDecoderContextKey string

+ type Input struct

+ BodyDecoder encdec.Decoder

+ Parameters ParameterCollection

+ Request *http.Request

+ RequestBodyParameter RequestBody

+ func (i Input) GetBody() (io.ReadCloser, error)

+ func (i Input) GetFormFile(key string) ([]byte, *multipart.FileHeader, error)

+ func (i Input) GetFormFiles(key string) ([]*multipart.FileHeader, error)

+ func (i Input) GetFormValue(key string) (string, error)

+ func (i Input) GetFormValues(key string) ([]string, error)

+ func (i Input) GetHeader(key string) (string, error)

+ func (i Input) GetQuery(key string) ([]string, error)

+ func (i Input) GetQueryString(key string) (string, error)

+ func (i Input) GetURIParam(key string) (string, error)

+ type InputContextKey string

+ type Method struct

+ Description string

+ HTTPMethod string

+ MethodOperation MethodOperation

+ RequestBody RequestBody

+ SecuritySchemes []*Security

+ Summary string

+ func NewMethod(httpMethod string, methodOperation MethodOperation, renderers Renderers) *Method

+ func (m *Method) GetDecoderMediaTypes() []string

+ func (m *Method) GetEncoderMediaTypes() []string

+ func (m *Method) Responses() []Response

+ func (m *Method) WithDescription(description string) *Method

+ func (m *Method) WithParameter(parameter Parameter) *Method

+ func (m *Method) WithRequestBody(description string, body interface{}) *Method

+ func (m *Method) WithSecurity(security *Security) *Method

+ func (m *Method) WithSummary(summary string) *Method

+ func (m *Method) WithValidation(validator Validator, failedValidationResponse Response) *Method

+ type MethodOperation struct

+ func NewMethodOperation(operation Operation, successResponse Response) MethodOperation

+ func (m MethodOperation) WithFailResponse(failResponse Response) MethodOperation

+ type MutableResponseBody interface

+ Mutate func(operationResultBody interface{}, success bool, err error)

+ type Negotiator interface

+ NegotiateDecoder func(*http.Request, *Renderers) (MIMEType string, decoder encdec.Decoder, err error)

+ NegotiateEncoder func(*http.Request, *Renderers) (MIMEType string, encoder encdec.Encoder, err error)

+ type OAuth2Flow struct

+ AuthorizationURL string

+ Name string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type Operation interface

+ Execute func(i Input) (body interface{}, success bool, err error)

+ type OperationFunc func(i Input) (body interface{}, success bool, err error)

+ func (f OperationFunc) Execute(i Input) (body interface{}, success bool, err error)

+ type Parameter struct

+ Body interface{}

+ Decoder encdec.Decoder

+ Description string

+ Example interface{}

+ HTTPType ParameterType

+ Name string

+ Required bool

+ Type reflect.Kind

+ func NewFileParameter(name string) Parameter

+ func NewFormDataParameter(name string, tpe reflect.Kind, decoder encdec.Decoder) Parameter

+ func NewHeaderParameter(name string, tpe reflect.Kind) Parameter

+ func NewQueryArrayParameter(name string, enumValues []interface{}) Parameter

+ func NewQueryParameter(name string, tpe reflect.Kind) Parameter

+ func NewURIParameter(name string, tpe reflect.Kind) Parameter

+ func (p Parameter) AsOptional() Parameter

+ func (p Parameter) AsRequired() Parameter

+ func (p Parameter) WithBody(body interface{}) Parameter

+ func (p Parameter) WithDescription(description string) Parameter

+ func (p Parameter) WithExample(example interface{}) Parameter

+ func (p Parameter) WithValidation(validator Validator, validationFailedResponse Response) Parameter

+ type ParameterCollection struct

+ func NewParameterCollection() ParameterCollection

+ func (p *ParameterCollection) AddParameter(parameter Parameter)

+ func (p *ParameterCollection) GetParameter(paramType ParameterType, name string) (Parameter, error)

+ func (p *ParameterCollection) Parameters() []Parameter

+ type ParameterType string

+ const FileParameter

+ const FormDataParameter

+ const HeaderParameter

+ const QueryParameter

+ const URIParameter

+ type Renderers struct

+ UnsupportedMediaTypeResponse Response

+ func NewRenderers() Renderers

+ func (h *Renderers) Add(mimeType string, ed encdec.EncoderDecoder, isDefault bool)

+ func (h *Renderers) AddDecoder(mimeType string, decoder encdec.Decoder, isDefault bool)

+ func (h *Renderers) AddEncoder(mimeType string, encoder encdec.Encoder, isDefault bool)

+ func (h *Renderers) GetDecoder(mimeType string) (encdec.Decoder, error)

+ func (h *Renderers) GetDefaultDecoder() (string, encdec.Decoder, error)

+ func (h *Renderers) GetDefaultEncoder() (string, encdec.Encoder, error)

+ func (h *Renderers) GetEncoder(mimeType string) (encdec.Encoder, error)

+ type RequestBody struct

+ Body interface{}

+ Description string

+ Required bool

+ type Resource struct

+ Description string

+ Summary string

+ func NewResource(name string) Resource

+ func (rs *Resource) AddMethod(method *Method)

+ func (rs *Resource) Connect(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Delete(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Get(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Head(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Methods() []Method

+ func (rs *Resource) Options(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Patch(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Path() string

+ func (rs *Resource) Post(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Put(methodOperation MethodOperation, renderers Renderers) *Method

+ func (rs *Resource) Trace(methodOperation MethodOperation, renderers Renderers) *Method

+ type ResourceCollection struct

+ func (rs *ResourceCollection) AddResource(resource Resource)

+ func (rs *ResourceCollection) Resource(name string, fn func(r *Resource))

+ func (rs *ResourceCollection) Resources() []Resource

+ type Response struct

+ func NewResponse(code int) Response

+ func (r Response) Body() interface{}

+ func (r Response) Code() int

+ func (r Response) Description() string

+ func (r Response) WithBody(body interface{}) Response

+ func (r Response) WithDescription(description string) Response

+ func (r Response) WithMutableBody(mutableResponseBody MutableResponseBody) Response

+ func (r Response) WithOperationResultBody(body interface{}) Response

+ type Security struct

+ Description string

+ Enforce bool

+ Name string

+ OAuth2Flows []OAuth2Flow

+ Type string

+ func NewOAuth2Security(name string, securityOperation SecurityOperation) *Security

+ func NewSecurity(name string, typ string, securityOperation SecurityOperation) *Security

+ func (s *Security) WithAuthCodeOAuth2Flow(authorizationURL, tokenURL string, scopes map[string]string) *Security

+ func (s *Security) WithClientCredentialOAuth2Flow(tokenURL string, scopes map[string]string) *Security

+ func (s *Security) WithImplicitOAuth2Flow(authorizationURL string, scopes map[string]string) *Security

+ func (s *Security) WithOAuth2Flow(flow OAuth2Flow) *Security

+ func (s *Security) WithPasswordOAuth2Flow(tokenURL string, scopes map[string]string) *Security

+ type SecurityOperation struct

+ FailedAuthenticationResponse Response

+ FailedAuthorizationResponse Response

+ type ServerGenerator interface

+ GenerateServer func(api API) http.Handler

+ GetURIParam func() func(r *http.Request, key string) string

+ type TypeErrorAuthentication struct

+ func (e *TypeErrorAuthentication) Error() string

+ type TypeErrorAuthorization struct

+ func (e *TypeErrorAuthorization) Error() string

+ type TypeErrorFailResponseNotDefined struct

+ func (e *TypeErrorFailResponseNotDefined) Error() string

+ type TypeErrorGetURIParamFunctionNotDefined struct

+ func (e *TypeErrorGetURIParamFunctionNotDefined) Error() string

+ type TypeErrorParameterNotDefined struct

+ func (e *TypeErrorParameterNotDefined) Error() string

+ type TypeErrorResourceSlashesNotAllowed struct

+ func (e *TypeErrorResourceSlashesNotAllowed) Error() string

+ type Validator interface

+ Validate func(Input) error

+ type ValidatorFunc func(i Input) error

+ func (f ValidatorFunc) Validate(i Input) error

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