Documentation ¶
Index ¶
- func WithServerURL(ctx context.Context, u *url.URL) context.Context
- type Client
- type ClientOption
- type DataGetIDParams
- type DataGetParams
- type ErrorHandler
- type Handler
- type Invoker
- type Middleware
- type Option
- type Route
- 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.
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 DataGetIDParams ¶
type DataGetIDParams struct {
ID int
}
DataGetIDParams is parameters of dataGetID operation.
type DataGetParams ¶
DataGetParams is parameters of dataGet operation.
type Handler ¶
type Handler interface { // DataGet implements dataGet operation. // // Retrieve data. // // GET /name/{id}/{key} DataGet(ctx context.Context, params DataGetParams) (string, error) // DataGetAny implements dataGetAny operation. // // Retrieve any data. // // GET /name DataGetAny(ctx context.Context) (string, error) // DataGetID implements dataGetID operation. // // Retrieve data. // // GET /name/{id} DataGetID(ctx context.Context, params DataGetIDParams) (string, error) }
Handler handles operations described by OpenAPI v3 specification.
type Invoker ¶
type Invoker interface { // DataGet invokes dataGet operation. // // Retrieve data. // // GET /name/{id}/{key} DataGet(ctx context.Context, params DataGetParams) (string, error) // DataGetAny invokes dataGetAny operation. // // Retrieve any data. // // GET /name DataGetAny(ctx context.Context) (string, error) // DataGetID invokes dataGetID operation. // // Retrieve data. // // GET /name/{id} DataGetID(ctx context.Context, params DataGetIDParams) (string, error) }
Invoker invokes operations described by OpenAPI v3 specification.
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 otel.GetMeterProvider() 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 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) DataGet ¶
func (UnimplementedHandler) DataGet(ctx context.Context, params DataGetParams) (r string, _ error)
DataGet implements dataGet operation.
Retrieve data.
GET /name/{id}/{key}
func (UnimplementedHandler) DataGetAny ¶
func (UnimplementedHandler) DataGetAny(ctx context.Context) (r string, _ error)
DataGetAny implements dataGetAny operation.
Retrieve any data.
GET /name
func (UnimplementedHandler) DataGetID ¶
func (UnimplementedHandler) DataGetID(ctx context.Context, params DataGetIDParams) (r string, _ error)
DataGetID implements dataGetID operation.
Retrieve data.
GET /name/{id}
Source Files ¶
- oas_cfg_gen.go
- oas_client_gen.go
- oas_faker_gen.go
- oas_handlers_gen.go
- oas_middleware_gen.go
- oas_parameters_gen.go
- oas_request_decoders_gen.go
- oas_request_encoders_gen.go
- oas_response_decoders_gen.go
- oas_response_encoders_gen.go
- oas_router_gen.go
- oas_schemas_gen.go
- oas_server_gen.go
- oas_unimplemented_gen.go