middleware

Documentation

Overview

Package middleware provides a middleware interface for ogen.

Index

• func HookMiddleware[RequestType, ParamsType, ResponseType any](m Middleware, req Request, unpack func(Parameters) ParamsType, ...) (r ResponseType, err error)
• type Middleware
  • func ChainMiddlewares(m ...Middleware) Middleware
• type Next
• type ParameterKey
• type Parameters
  • func (p Parameters) Cookie(name string) (any, bool)
  • func (p Parameters) Header(name string) (any, bool)
  • func (p Parameters) Path(name string) (any, bool)
  • func (p Parameters) Query(name string) (any, bool)
• type Request
• type Response

Functions

func HookMiddleware

func HookMiddleware[RequestType, ParamsType, ResponseType any](
	m Middleware,
	req Request,
	unpack func(Parameters) ParamsType,
	cb func(context.Context, RequestType, ParamsType) (ResponseType, error),
) (r ResponseType, err error)

HookMiddleware is a helper that does ogen request type -> Request type conversion.

NB: this is an internal func, not intended for public use.

Types

type Middleware

type Middleware func(req Request, next Next) (Response, error)

Middleware is middleware type.

func ChainMiddlewares

func ChainMiddlewares(m ...Middleware) Middleware

ChainMiddlewares chains middlewares into a single middleware, which will be executed in the order they are passed.

type Next

type Next = func(req Request) (Response, error)

Next is the next middleware/handler in the chain.

type ParameterKey

type ParameterKey struct {
	// Name is the name of the parameter.
	Name string
	// In is the location of the parameter.
	In openapi.ParameterLocation
}

ParameterKey is a map key for parameters.

type Parameters

type Parameters map[ParameterKey]any

Parameters is a map of parameters.

func (Parameters) Cookie

func (p Parameters) Cookie(name string) (any, bool)

Cookie returns a parameter from the cookie.

func (Parameters) Header

func (p Parameters) Header(name string) (any, bool)

Header returns a parameter from the header.

func (Parameters) Path

func (p Parameters) Path(name string) (any, bool)

Path returns a parameter from the path.

func (Parameters) Query

func (p Parameters) Query(name string) (any, bool)

Query returns a parameter from the query.

type Request

type Request struct {
	// Context is request context.
	Context context.Context
	// OperationName is the ogen operation name. It is guaranteed to be unique and not empty.
	OperationName string
	// OperationID is the spec operation ID, if any.
	OperationID string
	// Body is the operation request body. May be nil, if the operation has not body.
	Body any
	// Params is the operation parameters.
	Params Parameters
	// Raw is the raw http request.
	Raw *http.Request
}

Request is request context type for middleware.

type Response

type Response struct {
	// Type is the operation response type.
	Type any
}

Response is response type for middleware.