api

Documentation

Index

• func WithServerURL(ctx context.Context, u *url.URL) context.Context
• type Client
  • func NewClient(serverURL string, opts ...ClientOption) (*Client, error)
  • func (c *Client) ProbeLiveness(ctx context.Context) (string, error)
• type ClientOption
  • func WithClient(client ht.Client) ClientOption
• type Error
  • func (s *Error) Decode(d *jx.Decoder) error
  • func (s *Error) Encode(e *jx.Encoder)
  • func (s *Error) GetCode() int64
  • func (s *Error) GetMessage() string
  • func (s *Error) MarshalJSON() ([]byte, error)
  • func (s *Error) SetCode(val int64)
  • func (s *Error) SetMessage(val string)
  • func (s *Error) UnmarshalJSON(data []byte) error
• type ErrorHandler
• type ErrorStatusCode
  • func (s *ErrorStatusCode) Error() string
  • func (s *ErrorStatusCode) GetResponse() Error
  • func (s *ErrorStatusCode) GetStatusCode() int
  • func (s *ErrorStatusCode) SetResponse(val Error)
  • func (s *ErrorStatusCode) SetStatusCode(val int)
• type Handler
• type Middleware
• type Option
  • func WithMeterProvider(provider metric.MeterProvider) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option
• type Route
  • func (r Route) Args() []string
  • func (r Route) Name() string
  • func (r Route) OperationID() string
  • func (r Route) PathPattern() string
• type Server
  • func NewServer(h Handler, opts ...ServerOption) (*Server, error)
  • func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)
  • func (s *Server) FindRoute(method, path string) (Route, bool)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
• 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
  • func (UnimplementedHandler) NewError(ctx context.Context, err error) (r *ErrorStatusCode)
  • func (UnimplementedHandler) ProbeLiveness(ctx context.Context) (r string, _ error)

Functions

func WithServerURL

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

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) ProbeLiveness

func (c *Client) ProbeLiveness(ctx context.Context) (string, error)

ProbeLiveness invokes probeLiveness operation.

Liveness probe for kubernetes.

GET /healthz

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 Error

type Error struct {
	Code    int64  `json:"code"`
	Message string `json:"message"`
}

Represents error object. Ref: #/components/schemas/Error

func (*Error) Decode

func (s *Error) Decode(d *jx.Decoder) error

Decode decodes Error from json.

func (*Error) Encode

func (s *Error) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Error) GetCode

func (s *Error) GetCode() int64

GetCode returns the value of Code.

func (*Error) GetMessage

func (s *Error) GetMessage() string

GetMessage returns the value of Message.

func (*Error) MarshalJSON

func (s *Error) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetCode

func (s *Error) SetCode(val int64)

SetCode sets the value of Code.

func (*Error) SetMessage

func (s *Error) SetMessage(val string)

SetMessage sets the value of Message.

func (*Error) UnmarshalJSON

func (s *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorHandler

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ErrorStatusCode

type ErrorStatusCode struct {
	StatusCode int
	Response   Error
}

ErrorStatusCode wraps Error with StatusCode.

func (*ErrorStatusCode) Error

func (s *ErrorStatusCode) Error() string

func (*ErrorStatusCode) GetResponse

func (s *ErrorStatusCode) GetResponse() Error

GetResponse returns the value of Response.

func (*ErrorStatusCode) GetStatusCode

func (s *ErrorStatusCode) GetStatusCode() int

GetStatusCode returns the value of StatusCode.

func (*ErrorStatusCode) SetResponse

func (s *ErrorStatusCode) SetResponse(val Error)

SetResponse sets the value of Response.

func (*ErrorStatusCode) SetStatusCode

func (s *ErrorStatusCode) SetStatusCode(val int)

SetStatusCode sets the value of StatusCode.

type Handler

type Handler interface {
	// ProbeLiveness implements probeLiveness operation.
	//
	// Liveness probe for kubernetes.
	//
	// GET /healthz
	ProbeLiveness(ctx context.Context) (string, 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 Middleware

type Middleware = middleware.Middleware

Middleware is middleware type.

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) Args

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

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.

func (*Server) FindPath

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute

func (s *Server) FindRoute(method, path string) (Route, bool)

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

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) NewError

func (UnimplementedHandler) NewError(ctx context.Context, err error) (r *ErrorStatusCode)

NewError creates *ErrorStatusCode from error returned by handler.

Used for common default response.

func (UnimplementedHandler) ProbeLiveness

func (UnimplementedHandler) ProbeLiveness(ctx context.Context) (r string, _ error)

ProbeLiveness implements probeLiveness operation.

Liveness probe for kubernetes.

GET /healthz