Documentation
¶
Index ¶
- func WithServerURL(ctx context.Context, u *url.URL) context.Context
- type Client
- type ClientOption
- type ErrorHandler
- type Handler
- type HealthzGetOK
- type HealthzGetParams
- type Middleware
- type Option
- type Route
- type SameNameOK
- type SameNameParams
- type Server
- type ServerOption
- func WithErrorHandler(h ErrorHandler) ServerOption
- func WithMaxMultipartMemory(max int64) ServerOption
- func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption
- func WithMiddleware(m ...Middleware) ServerOption
- func WithNotFound(notFound http.HandlerFunc) ServerOption
- func WithPathPrefix(prefix string) ServerOption
- type UnimplementedHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client implements OAS client.
func NewClient ¶
func NewClient(serverURL string, opts ...ClientOption) (*Client, error)
NewClient initializes new Client defined by OAS.
func (*Client) HealthzGet ¶
func (c *Client) HealthzGet(ctx context.Context, params HealthzGetParams) (res HealthzGetOK, err error)
HealthzGet invokes GET /healthz operation.
GET /healthz
func (*Client) SameName ¶
func (c *Client) SameName(ctx context.Context, params SameNameParams) (res SameNameOK, err error)
SameName invokes sameName operation.
Parameter with different location, but the same name.
GET /same_name/{path}
type ClientOption ¶
type ClientOption interface {
// contains filtered or unexported methods
}
ClientOption is client config option.
func WithClient ¶
func WithClient(client ht.Client) ClientOption
WithClient specifies http client to use.
type Handler ¶
type Handler interface {
// HealthzGet implements GET /healthz operation.
//
// GET /healthz
HealthzGet(ctx context.Context, params HealthzGetParams) (HealthzGetOK, error)
// SameName implements sameName operation.
//
// Parameter with different location, but the same name.
//
// GET /same_name/{path}
SameName(ctx context.Context, params SameNameParams) (SameNameOK, error)
}
Handler handles operations described by OpenAPI v3 specification.
type HealthzGetParams ¶
HealthzGetParams is parameters of GET /healthz operation.
type Option ¶
type Option interface {
ServerOption
ClientOption
}
Option is config option.
func WithMeterProvider ¶
func WithMeterProvider(provider metric.MeterProvider) Option
WithMeterProvider specifies a meter provider to use for creating a meter.
If none is specified, the metric.NewNoopMeterProvider is used.
func WithTracerProvider ¶
func WithTracerProvider(provider trace.TracerProvider) Option
WithTracerProvider specifies a tracer provider to use for creating a tracer.
If none is specified, the global provider is used.
type Route ¶
type Route struct {
// contains filtered or unexported fields
}
Route is route object.
func (Route) OperationID ¶
OperationID returns OpenAPI operationId.
type SameNameParams ¶
type SameNameParams struct {
// contains filtered or unexported fields
}
SameNameParams is parameters of sameName operation.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.
func NewServer ¶
func NewServer(h Handler, opts ...ServerOption) (*Server, error)
NewServer creates new Server.
type ServerOption ¶
type ServerOption interface {
// contains filtered or unexported methods
}
ServerOption is server config option.
func WithErrorHandler ¶
func WithErrorHandler(h ErrorHandler) ServerOption
WithErrorHandler specifies error handler to use.
func WithMaxMultipartMemory ¶
func WithMaxMultipartMemory(max int64) ServerOption
WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.
func WithMethodNotAllowed ¶
func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption
WithMethodNotAllowed specifies Method Not Allowed handler to use.
func WithMiddleware ¶
func WithMiddleware(m ...Middleware) ServerOption
WithMiddleware specifies middlewares to use.
func WithNotFound ¶
func WithNotFound(notFound http.HandlerFunc) ServerOption
WithNotFound specifies Not Found handler to use.
func WithPathPrefix ¶
func WithPathPrefix(prefix string) ServerOption
WithPathPrefix specifies server path prefix.
type UnimplementedHandler ¶
type UnimplementedHandler struct{}
UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.
func (UnimplementedHandler) HealthzGet ¶
func (UnimplementedHandler) HealthzGet(ctx context.Context, params HealthzGetParams) (r HealthzGetOK, _ error)
HealthzGet implements GET /healthz operation.
GET /healthz
func (UnimplementedHandler) SameName ¶
func (UnimplementedHandler) SameName(ctx context.Context, params SameNameParams) (r SameNameOK, _ error)
SameName implements sameName operation.
Parameter with different location, but the same name.
GET /same_name/{path}
Source Files