Documentation
¶
Index ¶
- Constants
- Variables
- func SchemaPath(r *http.Request) (string, bool)
- func SpecFileHandler() http.Handler
- type API
- type Client
- func (c *Client) Get(ctx context.Context, request GetRequest) (GetResponse, error)
- func (c *Client) GetShops(ctx context.Context, request GetShopsRequest) (GetShopsResponse, error)
- func (c *Client) GetShopsActivate(ctx context.Context, request GetShopsActivateRequest) (GetShopsActivateResponse, error)
- func (c *Client) GetShopsRT(ctx context.Context, request GetShopsRTRequest) (GetShopsRTResponse, error)
- func (c *Client) GetShopsShop(ctx context.Context, request GetShopsShopRequest) (GetShopsShopResponse, error)
- func (c *Client) GetShopsShopPets(ctx context.Context, request GetShopsShopPetsRequest) (GetShopsShopPetsResponse, error)
- func (c *Client) GetShopsShopRT(ctx context.Context, request GetShopsShopRTRequest) (GetShopsShopRTResponse, error)
- type ErrParseParam
- type GetHandlerFunc
- type GetRequest
- type GetRequestParser
- type GetResponse
- type GetResponseDefault
- type GetShopsActivateHandlerFunc
- type GetShopsActivateRequest
- type GetShopsActivateRequestParser
- type GetShopsActivateResponse
- type GetShopsActivateResponseDefault
- type GetShopsHandlerFunc
- type GetShopsRTHandlerFunc
- type GetShopsRTRequest
- type GetShopsRTRequestParser
- type GetShopsRTResponse
- type GetShopsRTResponseDefault
- type GetShopsRequest
- type GetShopsRequestParser
- type GetShopsResponse
- type GetShopsResponseDefault
- type GetShopsShopHandlerFunc
- type GetShopsShopPetsHandlerFunc
- type GetShopsShopPetsRequest
- type GetShopsShopPetsRequestParser
- type GetShopsShopPetsResponse
- type GetShopsShopPetsResponseDefault
- type GetShopsShopRTHandlerFunc
- type GetShopsShopRTRequest
- type GetShopsShopRTRequestParser
- type GetShopsShopRTResponse
- type GetShopsShopRTResponseDefault
- type GetShopsShopRequest
- type GetShopsShopRequestParser
- type GetShopsShopResponse
- type GetShopsShopResponseDefault
- type HTTPClient
Constants ¶
View Source
const SpecFile string = `servers:
# - url: "https://demo.example.com:8443/api/v1"
- url: https://{username}.example.com:{port}/{basePath}
description: The production API server
variables:
username:
default: demo
port:
default: '8443'
basePath:
default: api/v1
paths:
# some ` + "`" + `comment` + "`" + `
/: {get: {responses: {default: {}}}}
/shops: {get: {responses: {default: {}}}}
/shops/: {get: {responses: {default: {}}}}
/shops/{shop}: {get: {parameters: [{in: path, name: shop, required: true, schema: {type: string}}], responses: {default: {}}}}
/shops/{shop}/: {get: {parameters: [{in: path, name: shop, required: true, schema: {type: string}}], responses: {default: {}}}}
/shops/{shop}/pets: {get: {parameters: [{in: path, name: shop, required: true, schema: {type: string}}], responses: {default: {}}}}
/shops/activate: {get: {responses: {default: {}}}}
`
Variables ¶
Functions ¶
func SpecFileHandler ¶
Types ¶
type API ¶
type API struct {
GetHandler GetHandlerFunc
GetShopsHandler GetShopsHandlerFunc
GetShopsRTHandler GetShopsRTHandlerFunc
GetShopsActivateHandler GetShopsActivateHandlerFunc
GetShopsShopHandler GetShopsShopHandlerFunc
GetShopsShopRTHandler GetShopsShopRTHandlerFunc
GetShopsShopPetsHandler GetShopsShopPetsHandlerFunc
// not found
NotFoundHandler http.Handler
// spec file
SpecFileHandler http.Handler
Middlewares []func(h http.Handler) http.Handler
}
type Client ¶ added in v0.0.2
type Client struct {
BaseURL string
HTTPClient HTTPClient
}
func NewClient ¶ added in v0.0.2
func NewClient(baseURL string, httpClient HTTPClient) *Client
func (*Client) Get ¶ added in v0.0.2
func (c *Client) Get(ctx context.Context, request GetRequest) (GetResponse, error)
Get - GET /
func (*Client) GetShops ¶ added in v0.0.2
func (c *Client) GetShops(ctx context.Context, request GetShopsRequest) (GetShopsResponse, error)
GetShops - GET /shops
func (*Client) GetShopsActivate ¶ added in v0.0.2
func (c *Client) GetShopsActivate(ctx context.Context, request GetShopsActivateRequest) (GetShopsActivateResponse, error)
GetShopsActivate - GET /shops/activate
func (*Client) GetShopsRT ¶ added in v0.0.2
func (c *Client) GetShopsRT(ctx context.Context, request GetShopsRTRequest) (GetShopsRTResponse, error)
GetShopsRT - GET /shops/
func (*Client) GetShopsShop ¶ added in v0.0.2
func (c *Client) GetShopsShop(ctx context.Context, request GetShopsShopRequest) (GetShopsShopResponse, error)
GetShopsShop - GET /shops/{shop}
func (*Client) GetShopsShopPets ¶ added in v0.0.2
func (c *Client) GetShopsShopPets(ctx context.Context, request GetShopsShopPetsRequest) (GetShopsShopPetsResponse, error)
GetShopsShopPets - GET /shops/{shop}/pets
func (*Client) GetShopsShopRT ¶ added in v0.0.2
func (c *Client) GetShopsShopRT(ctx context.Context, request GetShopsShopRTRequest) (GetShopsShopRTResponse, error)
GetShopsShopRT - GET /shops/{shop}/
type ErrParseParam ¶
func (ErrParseParam) Error ¶
func (e ErrParseParam) Error() string
func (ErrParseParam) Unwrap ¶
func (e ErrParseParam) Unwrap() error
type GetHandlerFunc ¶ added in v0.0.2
type GetHandlerFunc func(r GetRequestParser) GetResponse
func (GetHandlerFunc) ServeHTTP ¶ added in v0.0.2
func (f GetHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetRequest ¶ added in v0.0.2
func (GetRequest) Parse ¶ added in v0.0.2
func (r GetRequest) Parse() GetRequest
type GetRequestParser ¶ added in v0.0.2
type GetRequestParser interface {
Parse() GetRequest
}
func GetHTTPRequest ¶ added in v0.0.2
func GetHTTPRequest(r *http.Request) GetRequestParser
type GetResponse ¶ added in v0.0.2
type GetResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetResponseDefault ¶ added in v0.0.2
func NewGetResponseDefault(code int) GetResponse
type GetResponseDefault ¶ added in v0.0.2
type GetResponseDefault struct {
Code int
}
func (GetResponseDefault) Write ¶ added in v0.0.2
func (r GetResponseDefault) Write(w http.ResponseWriter)
type GetShopsActivateHandlerFunc ¶
type GetShopsActivateHandlerFunc func(r GetShopsActivateRequestParser) GetShopsActivateResponse
func (GetShopsActivateHandlerFunc) ServeHTTP ¶
func (f GetShopsActivateHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetShopsActivateRequest ¶
func (GetShopsActivateRequest) Parse ¶ added in v0.0.2
func (r GetShopsActivateRequest) Parse() GetShopsActivateRequest
type GetShopsActivateRequestParser ¶ added in v0.0.2
type GetShopsActivateRequestParser interface {
Parse() GetShopsActivateRequest
}
func GetShopsActivateHTTPRequest ¶ added in v0.0.2
func GetShopsActivateHTTPRequest(r *http.Request) GetShopsActivateRequestParser
type GetShopsActivateResponse ¶ added in v0.0.2
type GetShopsActivateResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetShopsActivateResponseDefault ¶ added in v0.0.2
func NewGetShopsActivateResponseDefault(code int) GetShopsActivateResponse
type GetShopsActivateResponseDefault ¶
type GetShopsActivateResponseDefault struct {
Code int
}
func (GetShopsActivateResponseDefault) Write ¶ added in v0.0.2
func (r GetShopsActivateResponseDefault) Write(w http.ResponseWriter)
type GetShopsHandlerFunc ¶
type GetShopsHandlerFunc func(r GetShopsRequestParser) GetShopsResponse
func (GetShopsHandlerFunc) ServeHTTP ¶
func (f GetShopsHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetShopsRTHandlerFunc ¶
type GetShopsRTHandlerFunc func(r GetShopsRTRequestParser) GetShopsRTResponse
func (GetShopsRTHandlerFunc) ServeHTTP ¶
func (f GetShopsRTHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetShopsRTRequest ¶
func (GetShopsRTRequest) Parse ¶ added in v0.0.2
func (r GetShopsRTRequest) Parse() GetShopsRTRequest
type GetShopsRTRequestParser ¶ added in v0.0.2
type GetShopsRTRequestParser interface {
Parse() GetShopsRTRequest
}
func GetShopsRTHTTPRequest ¶ added in v0.0.2
func GetShopsRTHTTPRequest(r *http.Request) GetShopsRTRequestParser
type GetShopsRTResponse ¶ added in v0.0.2
type GetShopsRTResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetShopsRTResponseDefault ¶ added in v0.0.2
func NewGetShopsRTResponseDefault(code int) GetShopsRTResponse
type GetShopsRTResponseDefault ¶
type GetShopsRTResponseDefault struct {
Code int
}
func (GetShopsRTResponseDefault) Write ¶ added in v0.0.2
func (r GetShopsRTResponseDefault) Write(w http.ResponseWriter)
type GetShopsRequest ¶
func (GetShopsRequest) Parse ¶ added in v0.0.2
func (r GetShopsRequest) Parse() GetShopsRequest
type GetShopsRequestParser ¶ added in v0.0.2
type GetShopsRequestParser interface {
Parse() GetShopsRequest
}
func GetShopsHTTPRequest ¶ added in v0.0.2
func GetShopsHTTPRequest(r *http.Request) GetShopsRequestParser
type GetShopsResponse ¶ added in v0.0.2
type GetShopsResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetShopsResponseDefault ¶ added in v0.0.2
func NewGetShopsResponseDefault(code int) GetShopsResponse
type GetShopsResponseDefault ¶
type GetShopsResponseDefault struct {
Code int
}
func (GetShopsResponseDefault) Write ¶ added in v0.0.2
func (r GetShopsResponseDefault) Write(w http.ResponseWriter)
type GetShopsShopHandlerFunc ¶
type GetShopsShopHandlerFunc func(r GetShopsShopRequestParser) GetShopsShopResponse
func (GetShopsShopHandlerFunc) ServeHTTP ¶
func (f GetShopsShopHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetShopsShopPetsHandlerFunc ¶
type GetShopsShopPetsHandlerFunc func(r GetShopsShopPetsRequestParser) GetShopsShopPetsResponse
func (GetShopsShopPetsHandlerFunc) ServeHTTP ¶
func (f GetShopsShopPetsHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetShopsShopPetsRequest ¶
func (GetShopsShopPetsRequest) Parse ¶ added in v0.0.2
func (r GetShopsShopPetsRequest) Parse() (GetShopsShopPetsRequest, error)
type GetShopsShopPetsRequestParser ¶ added in v0.0.2
type GetShopsShopPetsRequestParser interface {
Parse() (GetShopsShopPetsRequest, error)
}
func GetShopsShopPetsHTTPRequest ¶ added in v0.0.2
func GetShopsShopPetsHTTPRequest(r *http.Request) GetShopsShopPetsRequestParser
type GetShopsShopPetsResponse ¶ added in v0.0.2
type GetShopsShopPetsResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetShopsShopPetsResponseDefault ¶ added in v0.0.2
func NewGetShopsShopPetsResponseDefault(code int) GetShopsShopPetsResponse
type GetShopsShopPetsResponseDefault ¶
type GetShopsShopPetsResponseDefault struct {
Code int
}
func (GetShopsShopPetsResponseDefault) Write ¶ added in v0.0.2
func (r GetShopsShopPetsResponseDefault) Write(w http.ResponseWriter)
type GetShopsShopRTHandlerFunc ¶
type GetShopsShopRTHandlerFunc func(r GetShopsShopRTRequestParser) GetShopsShopRTResponse
func (GetShopsShopRTHandlerFunc) ServeHTTP ¶
func (f GetShopsShopRTHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetShopsShopRTRequest ¶
func (GetShopsShopRTRequest) Parse ¶ added in v0.0.2
func (r GetShopsShopRTRequest) Parse() (GetShopsShopRTRequest, error)
type GetShopsShopRTRequestParser ¶ added in v0.0.2
type GetShopsShopRTRequestParser interface {
Parse() (GetShopsShopRTRequest, error)
}
func GetShopsShopRTHTTPRequest ¶ added in v0.0.2
func GetShopsShopRTHTTPRequest(r *http.Request) GetShopsShopRTRequestParser
type GetShopsShopRTResponse ¶ added in v0.0.2
type GetShopsShopRTResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetShopsShopRTResponseDefault ¶ added in v0.0.2
func NewGetShopsShopRTResponseDefault(code int) GetShopsShopRTResponse
type GetShopsShopRTResponseDefault ¶
type GetShopsShopRTResponseDefault struct {
Code int
}
func (GetShopsShopRTResponseDefault) Write ¶ added in v0.0.2
func (r GetShopsShopRTResponseDefault) Write(w http.ResponseWriter)
type GetShopsShopRequest ¶
func (GetShopsShopRequest) Parse ¶ added in v0.0.2
func (r GetShopsShopRequest) Parse() (GetShopsShopRequest, error)
type GetShopsShopRequestParser ¶ added in v0.0.2
type GetShopsShopRequestParser interface {
Parse() (GetShopsShopRequest, error)
}
func GetShopsShopHTTPRequest ¶ added in v0.0.2
func GetShopsShopHTTPRequest(r *http.Request) GetShopsShopRequestParser
type GetShopsShopResponse ¶ added in v0.0.2
type GetShopsShopResponse interface {
Write(w http.ResponseWriter)
// contains filtered or unexported methods
}
func NewGetShopsShopResponseDefault ¶ added in v0.0.2
func NewGetShopsShopResponseDefault(code int) GetShopsShopResponse
type GetShopsShopResponseDefault ¶
type GetShopsShopResponseDefault struct {
Code int
}
func (GetShopsShopResponseDefault) Write ¶ added in v0.0.2
func (r GetShopsShopResponseDefault) Write(w http.ResponseWriter)
Click to show internal directories.
Click to hide internal directories.