Documentation ¶
Overview ¶
Code generated by ogen, DO NOT EDIT.
Index ¶
- type Client
- type Data
- type Error
- type ErrorHandler
- type ErrorStatusCode
- type Handler
- type OptData
- func (o *OptData) Decode(d *jx.Decoder) error
- func (o OptData) Encode(e *jx.Encoder)
- func (o OptData) Get() (v Data, ok bool)
- func (o OptData) IsSet() bool
- func (s OptData) MarshalJSON() ([]byte, error)
- func (o OptData) Or(d Data) Data
- func (o *OptData) Reset()
- func (s *OptData) SetFake()
- func (o *OptData) SetTo(v Data)
- func (s *OptData) UnmarshalJSON(data []byte) error
- type Option
- func WithClient(client ht.Client) Option
- func WithErrorHandler(h ErrorHandler) Option
- func WithMaxMultipartMemory(max int64) Option
- func WithMeterProvider(provider metric.MeterProvider) Option
- func WithNotFound(notFound http.HandlerFunc) Option
- func WithTracerProvider(provider trace.TracerProvider) Option
- type Route
- type Server
- type UnimplementedHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client implements OAS client.
type Data ¶
type Data struct {
Name string "json:\"name\""
}
Some data. Ref: #/components/schemas/Data
func (Data) MarshalJSON ¶ added in v0.20.0
MarshalJSON implements stdjson.Marshaler.
func (*Data) UnmarshalJSON ¶ added in v0.20.0
UnmarshalJSON implements stdjson.Unmarshaler.
type Error ¶
Represents error object. Ref: #/components/schemas/Error
func (Error) MarshalJSON ¶ added in v0.20.0
MarshalJSON implements stdjson.Marshaler.
func (*Error) UnmarshalJSON ¶ added in v0.20.0
UnmarshalJSON implements stdjson.Unmarshaler.
type ErrorHandler ¶ added in v0.25.0
ErrorHandler is error handler.
type ErrorStatusCode ¶
ErrorStatusCode wraps Error with StatusCode.
func (*ErrorStatusCode) Error ¶
func (s *ErrorStatusCode) Error() string
type Handler ¶
type Handler interface { // DataCreate implements dataCreate operation. // // Creates data. // // POST /data DataCreate(ctx context.Context, req OptData) (Data, error) // DataGet implements dataGet operation. // // Retrieve data. // // GET /data DataGet(ctx context.Context) (Data, error) // NewError creates ErrorStatusCode from error returned by handler. // // Used for common default response. NewError(ctx context.Context, err error) ErrorStatusCode }
Handler handles operations described by OpenAPI v3 specification.
type OptData ¶
OptData is optional Data.
func NewOptData ¶
NewOptData returns new OptData with value set to v.
func (OptData) MarshalJSON ¶ added in v0.20.0
MarshalJSON implements stdjson.Marshaler.
func (*OptData) UnmarshalJSON ¶ added in v0.20.0
UnmarshalJSON implements stdjson.Unmarshaler.
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
func WithErrorHandler ¶ added in v0.25.0
func WithErrorHandler(h ErrorHandler) Option
WithErrorHandler specifies error handler to use.
func WithMaxMultipartMemory ¶ added in v0.34.0
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 WithMeterProvider ¶ added in v0.13.0
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 WithNotFound ¶ added in v0.18.0
func WithNotFound(notFound http.HandlerFunc) Option
WithNotFound specifies Not Found handler to use.
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 ¶ added in v0.8.0
type Route struct {
// contains filtered or unexported fields
}
Route is route object.
func (Route) OperationID ¶ added in v0.8.0
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.
type UnimplementedHandler ¶ added in v0.18.0
type UnimplementedHandler struct{}
UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.
func (UnimplementedHandler) DataCreate ¶ added in v0.18.0
DataCreate implements dataCreate operation.
Creates data.
POST /data
func (UnimplementedHandler) DataGet ¶ added in v0.18.0
func (UnimplementedHandler) DataGet(ctx context.Context) (r Data, _ error)
DataGet implements dataGet operation.
Retrieve data.
GET /data
func (UnimplementedHandler) NewError ¶ added in v0.18.0
func (UnimplementedHandler) NewError(ctx context.Context, err error) (r ErrorStatusCode)
NewError creates ErrorStatusCode from error returned by handler.
Used for common default response.
Source Files ¶
- oas_cfg_gen.go
- oas_client_gen.go
- oas_defaults_gen.go
- oas_faker_gen.go
- oas_handlers_gen.go
- oas_interfaces_gen.go
- oas_json_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_security_gen.go
- oas_server_gen.go
- oas_unimplemented_gen.go
- oas_validators_gen.go