Documentation ¶
Overview ¶
Code generated by ogen, DO NOT EDIT.
Index ¶
- func WithServerURL(ctx context.Context, u *url.URL) context.Context
- type AuthFound
- type AuthInternalServerError
- type AuthRes
- type CallbackInternalServerError
- type CallbackOK
- type CallbackOKHeaders
- type CallbackParams
- type CallbackRes
- type Client
- type ClientOption
- type ErrorHandler
- type Handler
- type IndexInternalServerError
- type IndexOK
- type IndexRes
- type Invoker
- type Middleware
- type OptString
- type OptURI
- 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 AuthFound ¶
AuthFound is response for Auth operation.
func (*AuthFound) GetLocation ¶
GetLocation returns the value of Location.
func (*AuthFound) GetSetCookie ¶
GetSetCookie returns the value of SetCookie.
func (*AuthFound) SetLocation ¶
SetLocation sets the value of Location.
func (*AuthFound) SetSetCookie ¶
SetSetCookie sets the value of SetCookie.
type AuthInternalServerError ¶
type AuthInternalServerError struct{}
AuthInternalServerError is response for Auth operation.
type CallbackInternalServerError ¶
type CallbackInternalServerError struct{}
CallbackInternalServerError is response for Callback operation.
type CallbackOK ¶
type CallbackOKHeaders ¶
type CallbackOKHeaders struct { SetCookie OptString Response CallbackOK }
CallbackOKHeaders wraps CallbackOK with response headers.
func (*CallbackOKHeaders) GetResponse ¶
func (s *CallbackOKHeaders) GetResponse() CallbackOK
GetResponse returns the value of Response.
func (*CallbackOKHeaders) GetSetCookie ¶
func (s *CallbackOKHeaders) GetSetCookie() OptString
GetSetCookie returns the value of SetCookie.
func (*CallbackOKHeaders) SetResponse ¶
func (s *CallbackOKHeaders) SetResponse(val CallbackOK)
SetResponse sets the value of Response.
func (*CallbackOKHeaders) SetSetCookie ¶
func (s *CallbackOKHeaders) SetSetCookie(val OptString)
SetSetCookie sets the value of SetCookie.
type CallbackParams ¶
CallbackParams is parameters of callback operation.
type CallbackRes ¶
type CallbackRes interface {
// contains filtered or unexported methods
}
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) Callback ¶
func (c *Client) Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)
Callback invokes callback operation.
Callback.
GET /callback
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 { // Auth implements auth operation. // // Auth. // // GET /auth Auth(ctx context.Context) (AuthRes, error) // Callback implements callback operation. // // Callback. // // GET /callback Callback(ctx context.Context, params CallbackParams) (CallbackRes, error) // Index implements index operation. // // Index. // // GET / Index(ctx context.Context) (IndexRes, error) }
Handler handles operations described by OpenAPI v3 specification.
type IndexInternalServerError ¶
type IndexInternalServerError struct{}
IndexInternalServerError is response for Index operation.
type Invoker ¶
type Invoker interface { // Auth invokes auth operation. // // Auth. // // GET /auth Auth(ctx context.Context) (AuthRes, error) // Callback invokes callback operation. // // Callback. // // GET /callback Callback(ctx context.Context, params CallbackParams) (CallbackRes, error) // Index invokes index operation. // // Index. // // GET / Index(ctx context.Context) (IndexRes, error) }
Invoker invokes operations described by OpenAPI v3 specification.
type OptString ¶
OptString is optional string.
func NewOptString ¶
NewOptString returns new OptString with value set to v.
type OptURI ¶
OptURI is optional url.URL.
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) Auth ¶
func (UnimplementedHandler) Auth(ctx context.Context) (r AuthRes, _ error)
Auth implements auth operation.
Auth.
GET /auth
func (UnimplementedHandler) Callback ¶
func (UnimplementedHandler) Callback(ctx context.Context, params CallbackParams) (r CallbackRes, _ error)
Callback implements callback operation.
Callback.
GET /callback
Source Files ¶
- generate.go
- oas_cfg_gen.go
- oas_client_gen.go
- oas_handlers_gen.go
- oas_interfaces_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