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) FooBarBazGet(ctx context.Context) (string, error)
  • func (c *Client) FooBarQuxGet(ctx context.Context) (string, error)
  • func (c *Client) FooParamXyzGet(ctx context.Context, params FooParamXyzGetParams) (string, error)
• type ClientOption
  • func WithClient(client ht.Client) ClientOption
• type ErrorHandler
• type FooParamXyzGetParams
• type Handler
• type Invoker
• type Labeler
  • func LabelerFromContext(ctx context.Context) (*Labeler, bool)
  • func (l *Labeler) Add(attrs ...attribute.KeyValue)
  • func (l *Labeler) AttributeSet() attribute.Set
• type Middleware
• type OperationName
• 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
  • func (r Route) Summary() 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) FooBarBazGet(ctx context.Context) (r string, _ error)
  • func (UnimplementedHandler) FooBarQuxGet(ctx context.Context) (r string, _ error)
  • func (UnimplementedHandler) FooParamXyzGet(ctx context.Context, params FooParamXyzGetParams) (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) FooBarBazGet

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

FooBarBazGet invokes GET /foo/bar/baz operation.

GET /foo/bar/baz

func (*Client) FooBarQuxGet

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

FooBarQuxGet invokes GET /foo/bar/qux operation.

GET /foo/bar/qux

func (*Client) FooParamXyzGet

func (c *Client) FooParamXyzGet(ctx context.Context, params FooParamXyzGetParams) (string, error)

FooParamXyzGet invokes GET /foo/{param}/xyz operation.

GET /foo/{param}/xyz

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 ErrorHandler

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type FooParamXyzGetParams

type FooParamXyzGetParams struct {
	Param string
}

FooParamXyzGetParams is parameters of GET /foo/{param}/xyz operation.

type Handler

type Handler interface {
	// FooBarBazGet implements GET /foo/bar/baz operation.
	//
	// GET /foo/bar/baz
	FooBarBazGet(ctx context.Context) (string, error)
	// FooBarQuxGet implements GET /foo/bar/qux operation.
	//
	// GET /foo/bar/qux
	FooBarQuxGet(ctx context.Context) (string, error)
	// FooParamXyzGet implements GET /foo/{param}/xyz operation.
	//
	// GET /foo/{param}/xyz
	FooParamXyzGet(ctx context.Context, params FooParamXyzGetParams) (string, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker

type Invoker interface {
	// FooBarBazGet invokes GET /foo/bar/baz operation.
	//
	// GET /foo/bar/baz
	FooBarBazGet(ctx context.Context) (string, error)
	// FooBarQuxGet invokes GET /foo/bar/qux operation.
	//
	// GET /foo/bar/qux
	FooBarQuxGet(ctx context.Context) (string, error)
	// FooParamXyzGet invokes GET /foo/{param}/xyz operation.
	//
	// GET /foo/{param}/xyz
	FooParamXyzGet(ctx context.Context, params FooParamXyzGetParams) (string, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

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

func LabelerFromContext(ctx context.Context) (*Labeler, bool)

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

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet

func (l *Labeler) AttributeSet() attribute.Set

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type Middleware

type Middleware = middleware.Middleware

Middleware is middleware type.

type OperationName

type OperationName = string

OperationName is the ogen operation name

const (
	FooBarBazGetOperation   OperationName = "FooBarBazGet"
	FooBarQuxGetOperation   OperationName = "FooBarQuxGet"
	FooParamXyzGetOperation OperationName = "FooParamXyzGet"
)

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.

func (Route) Summary

func (r Route) Summary() string

Summary returns OpenAPI summary.

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

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

FooBarBazGet implements GET /foo/bar/baz operation.

GET /foo/bar/baz

func (UnimplementedHandler) FooBarQuxGet

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

FooBarQuxGet implements GET /foo/bar/qux operation.

GET /foo/bar/qux

func (UnimplementedHandler) FooParamXyzGet

func (UnimplementedHandler) FooParamXyzGet(ctx context.Context, params FooParamXyzGetParams) (r string, _ error)

FooParamXyzGet implements GET /foo/{param}/xyz operation.

GET /foo/{param}/xyz