Documentation
¶
Index ¶
- type Error
- type ErrorHandler
- type ErrorRespStatusCode
- type Handler
- type Healthy
- type Labeler
- type Middleware
- type OperationName
- 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 ¶
This section is empty.
Types ¶
type Error ¶
type Error struct {
Error string `json:"error"`
}
Ref: #/components/schemas/Error
func (*Error) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Error) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type ErrorRespStatusCode ¶
ErrorRespStatusCode wraps Error with StatusCode.
func (*ErrorRespStatusCode) Error ¶
func (s *ErrorRespStatusCode) Error() string
func (*ErrorRespStatusCode) GetResponse ¶
func (s *ErrorRespStatusCode) GetResponse() Error
GetResponse returns the value of Response.
func (*ErrorRespStatusCode) GetStatusCode ¶
func (s *ErrorRespStatusCode) GetStatusCode() int
GetStatusCode returns the value of StatusCode.
func (*ErrorRespStatusCode) SetResponse ¶
func (s *ErrorRespStatusCode) SetResponse(val Error)
SetResponse sets the value of Response.
func (*ErrorRespStatusCode) SetStatusCode ¶
func (s *ErrorRespStatusCode) SetStatusCode(val int)
SetStatusCode sets the value of StatusCode.
type Handler ¶
type Handler interface {
// Healthz implements healthz operation.
//
// Servers health check endpoint.
//
// GET /healthz
Healthz(ctx context.Context) (*Healthy, error)
// NewError creates *ErrorRespStatusCode from error returned by handler.
//
// Used for common default response.
NewError(ctx context.Context, err error) *ErrorRespStatusCode
}
Handler handles operations described by OpenAPI v3 specification.
type Healthy ¶
type Healthy struct {
Message string `json:"message"`
}
Ref: #/components/schemas/Healthy
func (*Healthy) GetMessage ¶
GetMessage returns the value of Message.
func (*Healthy) MarshalJSON ¶
MarshalJSON implements stdjson.Marshaler.
func (*Healthy) SetMessage ¶
SetMessage sets the value of Message.
func (*Healthy) UnmarshalJSON ¶
UnmarshalJSON implements stdjson.Unmarshaler.
type Labeler ¶
type Labeler struct {
// contains filtered or unexported fields
}
Labeler is used to allow adding custom attributes to the server request metrics.
func LabelerFromContext ¶
LabelerFromContext retrieves the Labeler from the provided context, if present.
If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.
func (*Labeler) AttributeSet ¶
AttributeSet returns the attributes added to the Labeler as an attribute.Set.
type OperationName ¶
type OperationName = string
OperationName is the ogen operation name
const (
HealthzOperation OperationName = "Healthz"
)
type Option ¶
type Option interface {
ServerOption
}
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 ¶ added in v1.0.0
type UnimplementedHandler struct{}
UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.
func (UnimplementedHandler) Healthz ¶ added in v1.0.0
func (UnimplementedHandler) Healthz(ctx context.Context) (r *Healthy, _ error)
Healthz implements healthz operation.
Servers health check endpoint.
GET /healthz
func (UnimplementedHandler) NewError ¶ added in v1.0.0
func (UnimplementedHandler) NewError(ctx context.Context, err error) (r *ErrorRespStatusCode)
NewError creates *ErrorRespStatusCode from error returned by handler.
Used for common default response.
Source Files