okapi

Apr 24, 2026

Changes in this version

type Group

+ func (g *Group) WithTagInfo(tags ...GroupTag) *Group

+ type GroupTag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ Name string

Mar 14, 2026

Changes in this version

type Context

+ func (c *Context) Next() error

type Middleware

+ func RequestID() Middleware

+ type MiddlewareFunc = HandlerFunc

type TestServer

+ func NewTestServerWithOkapi(t TestingT, o *Okapi) *TestServer

Feb 14, 2026

Changes in this version

type RouteDefinition

+ Tags []string

Feb 9, 2026

Changes in this version

+ func DefaultErrorHandler(c *Context, code int, message string, err error) error

type Context

+ func (c *Context) AbortValidationErrorsWithProblemDetail(errors []ValidationError, msg ...string) error

+ func (c *Context) AbortWithProblemDetail(problem *ProblemDetail) error

+ func (c *Context) NoContent() error

+ func (c *Context) Path() string

+ func (c *Context) PathParam(key string) string

+ func (c *Context) SetErrorHandler(handler ErrorHandler)

+ type ErrorFormat string

+ const ErrorFormatDefault

+ const ErrorFormatProblemJSON

+ const ErrorFormatProblemXML

+ type ErrorHandler func(c *Context, code int, message string, err error) error

+ func ProblemDetailErrorHandler(config *ErrorHandlerConfig) ErrorHandler

+ type ErrorHandlerConfig struct

+ CustomFields map[string]any

+ Format ErrorFormat

+ IncludeInstance bool

+ IncludeTimestamp bool

+ TypePrefix string

type HandlerFunc

+ func H[I any](h func(*Context, *I) error) HandlerFunc

+ func HandleIO[I any, O any](h func(*Context, *I) (*O, error)) HandlerFunc

+ func HandleO[O any](h func(*Context) (*O, error)) HandlerFunc

+ func Handle[I any](h func(*Context, *I) error) HandlerFunc

type Okapi

+ func (o *Okapi) WithDefaultErrorHandler() *Okapi

+ func (o *Okapi) WithErrorHandler(handler ErrorHandler) *Okapi

+ func (o *Okapi) WithProblemDetailErrorHandler(config *ErrorHandlerConfig) *Okapi

+ func (o *Okapi) WithSimpleProblemDetailErrorHandler() *Okapi

type OptionFunc

+ func WithDefaultErrorHandler() OptionFunc

+ func WithErrorHandler(handler ErrorHandler) OptionFunc

+ func WithProblemDetailErrorHandler(config *ErrorHandlerConfig) OptionFunc

+ func WithSimpleProblemDetailErrorHandler() OptionFunc

+ type ProblemDetail struct

+ Detail string

+ Extensions map[string]any

+ Instance string

+ Status int

+ Title string

+ Type string

+ func NewProblemDetail(code int, typeURI, detail string) *ProblemDetail

+ func (p *ProblemDetail) WithExtension(key string, value any) *ProblemDetail

+ func (p *ProblemDetail) WithInstance(instance string) *ProblemDetail

+ func (p *ProblemDetail) WithTimestamp() *ProblemDetail

+ func (p ProblemDetail) MarshalJSON() ([]byte, error)

Feb 7, 2026

Changes in this version

type Context

+ func (c *Context) Context() context.Context

Feb 1, 2026

Changes in this version

type Context

+ func (c *Context) AbortNotModified(msg string, err ...error) error

+ func (c *Context) ErrorNotModified(message any) error

+ type Ctx = *Context

Feb 1, 2026

Changes in this version

type Okapi

+ func (o *Okapi) WithDefaultRenderer(templatePath string) *Okapi

+ func (o *Okapi) WithRendererConfig(config TemplateConfig) *Okapi

+ func (o *Okapi) WithRendererFromDirectory(dir string, extensions ...string) *Okapi

+ func (o *Okapi) WithRendererFromFS(fsys fs.FS, pattern string) *Okapi

+ type Template struct

+ func NewTemplate(fsys fs.FS, pattern string) (*Template, error)

+ func NewTemplateFromDirectory(dir string, extensions ...string) (*Template, error)

+ func NewTemplateFromFiles(pattern string) (*Template, error)

+ func NewTemplateWithConfig(config TemplateConfig) (*Template, error)

+ func (t *Template) AddTemplate(name, content string) error

+ func (t *Template) AddTemplateFile(filepath string) error

+ func (t *Template) Render(w io.Writer, name string, data interface{}, _ *Context) error

+ type TemplateConfig struct

+ BaseDir string

+ FS fs.FS

+ Funcs template.FuncMap

+ Pattern string

Jan 25, 2026

Changes in this version

type Okapi

+ func (o *Okapi) StopWithContext(ctx context.Context) error

+ func (o *Okapi) WithContext(ctx context.Context) *Okapi

Jan 24, 2026

Changes in this version

type OptionFunc

+ func WithContext(ctx context.Context) OptionFunc

Jan 24, 2026

Changes in this version

type Location

+ func (l *Location) ToOpenAPI() openapi3.Location

type Okapi

+ func (o *Okapi) PrintServerInfo()

type Origin

+ func (o *Origin) ToOpenAPI() *openapi3.Origin

type SecurityScheme

+ Extensions map[string]any

+ In string

+ Origin *Origin

Jan 21, 2026

Changes in this version

+ type Base64Serializer struct

+ func (b Base64Serializer) Serialize(data any) (string, error)

type Context

+ func (c *Context) Params() map[string]string

+ func (c *Context) SSESendBinary(data []byte) error

+ func (c *Context) SSESendData(data any) error

+ func (c *Context) SSESendEvent(id, eventType string, data any) error

+ func (c *Context) SSESendJSON(data any) error

+ func (c *Context) SSESendText(text string) error

+ func (c *Context) SSEStreamWithOptions(ctx context.Context, messageChan <-chan Message, opts *StreamOptions) error

+ func (c *Context) SendSSECustom(data any, serializer Serializer) error

+ type JSONSerializer struct

+ func (j JSONSerializer) Serialize(data any) (string, error)

type Message

+ Serializer Serializer

+ type Serializer interface

+ Serialize func(data any) (string, error)

+ type StreamOptions struct

+ OnError func(error)

+ PingInterval time.Duration

+ Serializer Serializer

+ type TextSerializer struct

+ func (t TextSerializer) Serialize(data any) (string, error)

Jan 19, 2026

Changes in this version

+ type C = *Context

+ type HandlerFunc func(*Context) error

type Okapi

+ func (o *Okapi) StartForTest(t TestingT) string

+ func (o *Okapi) WaitForServer(timeout time.Duration) string

type ResponseWriter

+ BytesWritten func() int

+ Flush func()

+ Push func(string, *http.PushOptions) error

+ type TestServer struct

+ BaseURL string

+ func NewTestServer(t TestingT) *TestServer

+ func NewTestServerOn(t TestingT, port int) *TestServer

+ type TestingT interface

+ Cleanup func(func())

+ Errorf func(format string, args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Helper func()

Jan 17, 2026

Changes in this version

type Context

+ func NewContext(o *Okapi, w http.ResponseWriter, r *http.Request) *Context

+ func NewTestContext(method, url string, body io.Reader) (*Context, *httptest.ResponseRecorder)

+ func (c *Context) SSEStream(ctx context.Context, messageChan <-chan Message) error

Dec 14, 2025

Changes in this version

type DocBuilder

+ func (b *DocBuilder) PathParamWithDefault(name, typ, desc string, defvalue any) *DocBuilder

type Okapi

+ func (o *Okapi) RegisterSchemas(schemas map[string]*SchemaInfo) error

type OpenAPI

+ ComponentSchemas map[string]*SchemaInfo

type RouteOption

+ func DocPathParamWithDefault(name, typ, desc string, defvalue any) RouteOption

Dec 1, 2025

Changes in this version

type Context

+ func (c *Context) QueryArray(key string) []string

+ func (c *Context) Respond(output any) error

+ func (c *Context) Return(output any) error

type DocBuilder

+ func (b *DocBuilder) HeaderWithDefault(name, typ, desc string, required bool, defvalue any) *DocBuilder

+ func (b *DocBuilder) QueryParamWithDefault(name, typ, desc string, required bool, defvalue any) *DocBuilder

+ type ResponseWriter interface

+ Close func()

+ Hijack func() (net.Conn, *bufio.ReadWriter, error)

+ StatusCode func() int

type Route

+ func (r *Route) WithIO(req any, res any) *Route

+ func (r *Route) WithInput(req any) *Route

+ func (r *Route) WithOutput(res any) *Route

type RouteDefinition

+ Description string

+ Request any

+ Response any

+ Summary string

type RouteOption

+ func Deprecated() RouteOption

+ func Description(description string) RouteOption

+ func DocHeaderWithDefault(name, typ, desc string, required bool, defvalue any) RouteOption

+ func DocQueryParamWithDefault(name, typ, desc string, required bool, defvalue any) RouteOption

+ func Hide() RouteOption

+ func OperationId(operationId string) RouteOption

+ func Request(v any) RouteOption

+ func Summary(summary string) RouteOption

+ func Tag(tag string) RouteOption

+ func Tags(tags ...string) RouteOption

+ func WithIO(req any, res any) RouteOption

Aug 20, 2025

Changes in this version

type DocBuilder

+ func (b *DocBuilder) Hide() *DocBuilder

+ func (b *DocBuilder) OperationId(operationId string) *DocBuilder

+ type ExternalDocs struct

+ Description string

+ Extensions map[string]any

+ Origin *Origin

+ URL string

+ func (e *ExternalDocs) ToOpenAPI() *openapi3.ExternalDocs

+ type Location struct

+ Column int

+ Line int

type Okapi

+ func (o *Okapi) StartOn(port int) error

type OpenAPI

+ ExternalDocs *ExternalDocs

+ type Origin struct

+ Fields map[string]Location

+ Key *Location

type Route

+ func (r *Route) Hide() *Route

type RouteDefinition

+ OperationId string

type RouteOption

+ func DocHide() RouteOption

+ func DocOperationId(operationId string) RouteOption

Aug 9, 2025

Changes in this version

type Context

+ func (c *Context) SendSSEvent(id, name string, message any) error

type Group

+ func (g *Group) WithBasicAuth() *Group

+ func (g *Group) WithSecurity(security []map[string][]string) *Group

+ type OAuthFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ func (f *OAuthFlow) ToOpenAPI() *openapi3.OAuthFlow

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ func (flows *OAuthFlows) ToOpenAPI() *openapi3.OAuthFlows

type Route

+ func (r *Route) WithSecurity(security ...map[string][]string) *Route

type RouteDefinition

+ Security []map[string][]string

type RouteOption

+ func DocBasicAuth() RouteOption

+ type SecurityRequirement map[string][]string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows *OAuthFlows

+ Name string

+ Scheme string

+ Type string

+ type SecuritySchemes []SecurityScheme

+ func (ss SecuritySchemes) ToOpenAPI() openapi3.SecuritySchemes

Jul 12, 2025

Changes in this version

type OpenAPI

+ License License

type RouteDefinition

+ Middlewares []Middleware

Jun 25, 2025

Changes in this version

type JWTAuth

+ OnUnauthorized HandleFunc

Jun 23, 2025

Changes in this version

type Context

+ func (c *Context) Logger() *slog.Logger

type OpenAPI

+ SecuritySchemes openapi3.SecuritySchemes

type Route

+ func (r *Route) Deprecated() *Route

+ func (r *Route) Use(m ...Middleware)

type RouteOption

+ func UseMiddleware(m ...Middleware) RouteOption

Jun 21, 2025

Changes in this version

type Context

+ func (c *Context) ResponseWriter() http.ResponseWriter

type Response

+ StatusCode func() int

Jun 21, 2025

Changes in this version

+ func RegisterRoutes(o *Okapi, routes []RouteDefinition)

type DocBuilder

+ func (b *DocBuilder) Description(description string) *DocBuilder

+ func (b *DocBuilder) ResponseHeader(name, typ string, desc ...string) *DocBuilder

type Group

+ Prefix string

+ Tags []string

+ func NewGroup(basePath string, okapi *Okapi, middlewares ...Middleware) *Group

+ func (g *Group) Register(routes ...RouteDefinition)

+ func (g *Group) WithTags(tags []string) *Group

type Okapi

+ func (o *Okapi) Register(routes ...RouteDefinition)

+ type RouteDefinition struct

+ Group *Group

+ Handler HandleFunc

+ Method string

+ Options []RouteOption

+ Path string

type RouteOption

+ func DocDescription(description string) RouteOption

+ func DocResponseHeader(name, typ string, desc ...string) RouteOption

Jun 18, 2025

Changes in this version

+ type AndExpr struct

+ Left Expression

+ Right Expression

+ func And(left, right Expression) *AndExpr

+ func (a *AndExpr) Evaluate(claims jwt.MapClaims) (bool, error)

+ type ContainsExpr struct

+ ClaimKey string

+ IsArray bool

+ Values []string

+ func Contains(claimKey string, values ...string) *ContainsExpr

+ func (c *ContainsExpr) Evaluate(claims jwt.MapClaims) (bool, error)

+ type EqualsExpr struct

+ ClaimKey string

+ Expected string

+ func Equals(claimKey, expected string) *EqualsExpr

+ func (e *EqualsExpr) Evaluate(claims jwt.MapClaims) (bool, error)

+ type Expression interface

+ Evaluate func(claims jwt.MapClaims) (bool, error)

+ func ParseExpression(input string) (Expression, error)

+ type ExpressionParser struct

type Group

+ func (g *Group) Deprecated() *Group

type JWTAuth

+ ClaimsExpression string

+ ForwardClaims map[string]string

+ SigningSecret []byte

+ ValidateClaims func(claims jwt.Claims) error

+ type NotExpr struct

+ Expr Expression

+ func Not(expr Expression) *NotExpr

+ func (n *NotExpr) Evaluate(claims jwt.MapClaims) (bool, error)

+ type OneOfExpr struct

+ ClaimKey string

+ Values []string

+ func OneOf(claimKey string, values ...string) *OneOfExpr

+ func (o *OneOfExpr) Evaluate(claims jwt.MapClaims) (bool, error)

+ type OrExpr struct

+ Left Expression

+ Right Expression

+ func Or(left, right Expression) *OrExpr

+ func (o *OrExpr) Evaluate(claims jwt.MapClaims) (bool, error)

+ type PrefixExpr struct

+ ClaimKey string

+ Prefix string

+ func Prefix(claimKey, prefix string) *PrefixExpr

+ func (p *PrefixExpr) Evaluate(claims jwt.MapClaims) (bool, error)

Jun 12, 2025

Changes in this version

type Context

+ func (c *Context) SSEvent(name string, message any) error

type Group

+ func (g *Group) Connect(path string, h HandleFunc, opts ...RouteOption) *Route

+ func (g *Group) WithBearerAuth() *Group

type JWTAuth

+ ValidateRole func(claims jwt.Claims) error

type Message

+ Retry uint

type Okapi

+ func (o *Okapi) NoMethod(h HandleFunc)

+ func (o *Okapi) NoRoute(h HandleFunc)

+ func (o *Okapi) WithOpenAPIDisabled() *Okapi

+ func (o *Okapi) WithRenderer(renderer Renderer) *Okapi

type OptionFunc

+ func WithMuxRouter(router *mux.Router) OptionFunc

+ func WithRenderer(renderer Renderer) OptionFunc

+ type SendFunc func(data any, eventType string) (string, error)

Jun 9, 2025

Changes in this version

+ type BasicAuth struct

+ ContextKey string

+ Password string

+ Realm string

+ Username string

+ func (b *BasicAuth) Middleware(next HandleFunc) HandleFunc

type Group

+ func (g *Group) HandleHTTP(method, path string, h http.Handler, opts ...RouteOption)

+ func (g *Group) HandleStd(method, path string, h func(http.ResponseWriter, *http.Request), ...)

+ func (g *Group) UseMiddleware(mw func(http.Handler) http.Handler)

type JWTAuth

+ Algo string

+ Audience string

+ Issuer string

+ JwksFile *Jwks

+ JwksUrl string

+ RsaKey *rsa.PublicKey

+ type Jwk struct

+ Crv string

+ E string

+ Kid string

+ Kty string

+ N string

+ X string

+ Y string

+ type Jwks struct

+ Keys []Jwk

+ func LoadJWKSFromFile(jwksInput string) (*Jwks, error)

+ type Store struct

+ func NewStoreData() *Store

Jun 8, 2025

Changes in this version

type Context

+ func (c *Context) Created(v any) error

type DocBuilder

+ func (b *DocBuilder) Deprecated() *DocBuilder

type Okapi

+ func (o *Okapi) HandleHTTP(method, path string, h http.Handler, opts ...RouteOption)

+ func (o *Okapi) HandleStd(method, path string, h func(http.ResponseWriter, *http.Request), ...)

+ func (o *Okapi) UseMiddleware(mw func(http.Handler) http.Handler)

type RouteOption

+ func DocDeprecated() RouteOption

Jun 6, 2025

Changes in this version

type Context

+ func (c *Context) SetMaxMultipartMemory(max int64)

type DocBuilder

+ func (b *DocBuilder) ErrorResponse(status int, v any) *DocBuilder

type Okapi

+ func (o *Okapi) WithMaxMultipartMemory(max int64) *Okapi

type OptionFunc

+ func WithMaxMultipartMemory(max int64) OptionFunc

type Route

+ ErrorResponses map[int]*openapi3.SchemaRef

type RouteOption

+ func DocErrorResponse(status int, v any) RouteOption

Jun 5, 2025

Changes in this version

+ type DocBuilder struct

+ func Doc() *DocBuilder

+ func (b *DocBuilder) AsOption() RouteOption

+ func (b *DocBuilder) BearerAuth() *DocBuilder

+ func (b *DocBuilder) Build() RouteOption

+ func (b *DocBuilder) Header(name, typ, desc string, required bool) *DocBuilder

+ func (b *DocBuilder) PathParam(name, typ, desc string) *DocBuilder

+ func (b *DocBuilder) QueryParam(name, typ, desc string, required bool) *DocBuilder

+ func (b *DocBuilder) RequestBody(v any) *DocBuilder

+ func (b *DocBuilder) Response(v any) *DocBuilder

+ func (b *DocBuilder) Summary(summary string) *DocBuilder

+ func (b *DocBuilder) Tags(tags ...string) *DocBuilder

type Group

+ func (g *Group) Disable() *Group

+ func (g *Group) Enable() *Group

+ func (g *Group) SetDisabled(disabled bool) *Group

type Route

+ func (r *Route) Disable() *Route

+ func (r *Route) Enable() *Route

+ func (r *Route) SetDisabled(disabled bool) *Route

Jun 4, 2025

Changes in this version

+ func IsClientError(code int) bool

+ func IsError(code int) bool

+ func IsServerError(code int) bool

+ type Contact struct

+ Email string

+ Extensions map[string]any

+ Name string

+ URL string

+ func (c Contact) ToOpenAPI() *openapi3.Contact

type Context

+ func (c *Context) AbortBadGateway(msg ...string) error

+ func (c *Context) AbortExpectationFailed(msg ...string) error

+ func (c *Context) AbortFailedDependency(msg ...string) error

+ func (c *Context) AbortGatewayTimeout(msg ...string) error

+ func (c *Context) AbortGone(msg ...string) error

+ func (c *Context) AbortHTTPVersionNotSupported(msg ...string) error

+ func (c *Context) AbortInsufficientStorage(msg ...string) error

+ func (c *Context) AbortInternalServerError(msg ...string) error

+ func (c *Context) AbortLengthRequired(msg ...string) error

+ func (c *Context) AbortLocked(msg ...string) error

+ func (c *Context) AbortLoopDetected(msg ...string) error

+ func (c *Context) AbortMethodNotAllowed(msg ...string) error

+ func (c *Context) AbortMisdirectedRequest(msg ...string) error

+ func (c *Context) AbortNetworkAuthenticationRequired(msg ...string) error

+ func (c *Context) AbortNotAcceptable(msg ...string) error

+ func (c *Context) AbortNotExtended(msg ...string) error

+ func (c *Context) AbortNotImplemented(msg ...string) error

+ func (c *Context) AbortPaymentRequired(msg ...string) error

+ func (c *Context) AbortPreconditionFailed(msg ...string) error

+ func (c *Context) AbortPreconditionRequired(msg ...string) error

+ func (c *Context) AbortProxyAuthRequired(msg ...string) error

+ func (c *Context) AbortRequestEntityTooLarge(msg ...string) error

+ func (c *Context) AbortRequestHeaderFieldsTooLarge(msg ...string) error

+ func (c *Context) AbortRequestTimeout(msg ...string) error

+ func (c *Context) AbortRequestURITooLong(msg ...string) error

+ func (c *Context) AbortRequestedRangeNotSatisfiable(msg ...string) error

+ func (c *Context) AbortServiceUnavailable(msg ...string) error

+ func (c *Context) AbortTeapot(msg ...string) error

+ func (c *Context) AbortTooEarly(msg ...string) error

+ func (c *Context) AbortUnavailableForLegalReasons(msg ...string) error

+ func (c *Context) AbortUnsupportedMediaType(msg ...string) error

+ func (c *Context) AbortUpgradeRequired(msg ...string) error

+ func (c *Context) AbortValidationErrors(errors []ValidationError, msg ...string) error

+ func (c *Context) AbortVariantAlsoNegotiates(msg ...string) error

+ func (c *Context) ErrorBadGateway(message any) error

+ func (c *Context) ErrorExpectationFailed(message any) error

+ func (c *Context) ErrorFailedDependency(message any) error

+ func (c *Context) ErrorGatewayTimeout(message any) error

+ func (c *Context) ErrorGone(message any) error

+ func (c *Context) ErrorHTTPVersionNotSupported(message any) error

+ func (c *Context) ErrorInsufficientStorage(message any) error

+ func (c *Context) ErrorLengthRequired(message any) error

+ func (c *Context) ErrorLocked(message any) error

+ func (c *Context) ErrorLoopDetected(message any) error

+ func (c *Context) ErrorMethodNotAllowed(message any) error

+ func (c *Context) ErrorMisdirectedRequest(message any) error

+ func (c *Context) ErrorNetworkAuthenticationRequired(message any) error

+ func (c *Context) ErrorNotAcceptable(message any) error

+ func (c *Context) ErrorNotExtended(message any) error

+ func (c *Context) ErrorNotImplemented(message any) error

+ func (c *Context) ErrorPaymentRequired(message any) error

+ func (c *Context) ErrorPreconditionFailed(message any) error

+ func (c *Context) ErrorPreconditionRequired(message any) error

+ func (c *Context) ErrorProxyAuthRequired(message any) error

+ func (c *Context) ErrorRequestEntityTooLarge(message any) error

+ func (c *Context) ErrorRequestHeaderFieldsTooLarge(message any) error

+ func (c *Context) ErrorRequestTimeout(message any) error

+ func (c *Context) ErrorRequestURITooLong(message any) error

+ func (c *Context) ErrorRequestedRangeNotSatisfiable(message any) error

+ func (c *Context) ErrorTeapot(message any) error

+ func (c *Context) ErrorTooEarly(message any) error

+ func (c *Context) ErrorUnavailableForLegalReasons(message any) error

+ func (c *Context) ErrorUnsupportedMediaType(message any) error

+ func (c *Context) ErrorUpgradeRequired(message any) error

+ func (c *Context) ErrorVariantAlsoNegotiates(message any) error

+ func (c *Context) OK(v any) error

type ErrorResponse

+ Path string

+ Timestamp time.Time

+ type License struct

+ Extensions map[string]any

+ Name string

+ URL string

+ func (l License) ToOpenAPI() *openapi3.License

type OpenAPI

+ Contact Contact

+ Licence License

+ func (o OpenAPI) ToOpenAPISpec() *openapi3.T

type OptionFunc

+ func WithOpenAPIDisabled() OptionFunc

type Route

+ Description string

+ RequestExample map[string]interface{}

+ ResponseExample map[string]interface{}

+ Responses map[int]any

type RouteOption

+ func DocRequestBody(v any) RouteOption

+ type SchemaInfo struct

+ Package string

+ Schema *openapi3.SchemaRef

+ TypeName string

+ type Server struct

+ Description string

+ Extensions map[string]any

+ URL string

+ type Servers []Server

+ func (s Servers) ToOpenAPI() openapi3.Servers

+ type ValidationError struct

+ Field string

+ Message string

+ Value any

+ type ValidationErrorResponse struct

+ Errors []ValidationError

Jun 3, 2025

Changes in this version

+ const Bool

+ const Date

+ const DateTime

+ const Float

+ const Int

+ const Int64

+ const OpenApiDocPrefix

+ const OpenApiURL

+ const OpenApiVersion

+ const String

+ const UUID

type Okapi

+ func (o *Okapi) DisableAccessLog() *Okapi

+ func (o *Okapi) Handle(method, path string, h http.Handler, opts ...RouteOption)

+ func (o *Okapi) WithAddr(addr string) *Okapi

+ func (o *Okapi) WithCORS(cors Cors) *Okapi

+ func (o *Okapi) WithDebug() *Okapi

+ func (o *Okapi) WithIdleTimeout(seconds int) *Okapi

+ func (o *Okapi) WithLogger(logger *slog.Logger) *Okapi

+ func (o *Okapi) WithOpenAPIDocs(cfg ...OpenAPI) *Okapi

+ func (o *Okapi) WithPort(port int) *Okapi

+ func (o *Okapi) WithReadTimeout(seconds int) *Okapi

+ func (o *Okapi) WithStrictSlash(strict bool) *Okapi

+ func (o *Okapi) WithWriteTimeout(seconds int) *Okapi

+ type OpenAPI struct

+ PathPrefix string

+ Servers openapi3.Servers

+ Title string

+ Version string

type OptionFunc

+ func WithTLS(tlsConfig *tls.Config) OptionFunc

type Route

+ GroupPath string

+ Headers []*openapi3.ParameterRef

+ PathParams []*openapi3.ParameterRef

+ QueryParams []*openapi3.ParameterRef

+ Request *openapi3.SchemaRef

+ RequiresAuth bool

+ Response *openapi3.SchemaRef

+ Summary string

+ Tags []string

+ type RouteOption func(*Route)

+ func DocAutoPathParams() RouteOption

+ func DocBearerAuth() RouteOption

+ func DocHeader(name, typ, desc string, required bool) RouteOption

+ func DocPathParam(name, typ, desc string) RouteOption

+ func DocQueryParam(name, typ, desc string, required bool) RouteOption

+ func DocRequest(v any) RouteOption

+ func DocResponse(v any) RouteOption

+ func DocSummary(summary string) RouteOption

+ func DocTag(tag string) RouteOption

+ func DocTags(tags ...string) RouteOption

May 29, 2025

Changes in this version

+ func LoadTLSConfig(certFile, keyFile, caFile string, clientAuth bool) (*tls.Config, error)

type OptionFunc

+ func WithDisabledKeepAlives() OptionFunc

+ func WithIdleTimeout(t int) OptionFunc

+ func WithReadTimeout(t int) OptionFunc

+ func WithTls(tlsConfig *tls.Config) OptionFunc

+ func WithWriteTimeout(t int) OptionFunc

May 29, 2025

Changes in this version

+ const AccessControlAllowCredentials

+ const AccessControlAllowHeaders

+ const AccessControlAllowMethods

+ const AccessControlAllowOrigin

+ const AccessControlExposeHeaders

+ const AccessControlMaxAge

type Context

+ func (c *Context) Abort(err error) error

+ func (c *Context) AbortBadRequest(err error) error

+ func (c *Context) AbortConflict(err error) error

+ func (c *Context) AbortForbidden(err error) error

+ func (c *Context) AbortNotFound(err error) error

+ func (c *Context) AbortTooManyRequests(err error) error

+ func (c *Context) AbortUnauthorized(err error) error

+ func (c *Context) AbortValidationError(err error) error

+ func (c *Context) AbortWithJSON(code int, jsonObj interface{}) error

+ func (c *Context) AbortWithStatus(code int, message string) error

+ func (c *Context) ErrorBadRequest(message string) error

+ func (c *Context) ErrorConflict(message string) error

+ func (c *Context) ErrorForbidden(message string) error

+ func (c *Context) ErrorInternalServerError(message string) error

+ func (c *Context) ErrorNotFound(message string) error

+ func (c *Context) ErrorServiceUnavailable(message string) error

+ func (c *Context) ErrorTooManyRequests(message string) error

+ func (c *Context) ErrorUnauthorized(message string) error

+ func (c *Context) ErrorUnprocessableEntity(message string) error

+ type Cors struct

+ AllowCredentials bool

+ AllowMethods []string

+ AllowedHeaders []string

+ AllowedOrigins []string

+ ExposeHeaders []string

+ Headers map[string]string

+ MaxAge int

+ func (cors Cors) CORSHandler(next HandleFunc) HandleFunc

+ type ErrorResponse struct

+ Code int

+ Details string

+ Message string

type OptionFunc

+ func WithCors(cors Cors) OptionFunc

May 28, 2025

Changes in this version

+ const AcceptHeader

+ const CONNECT

+ const CSV

+ const ContentTypeHeader

+ const DELETE

+ const FORM

+ const FormData

+ const FormURLEncoded

+ const FrameworkName

+ const GET

+ const HEAD

+ const HTML

+ const JAVASCRIPT

+ const JSON

+ const LocationHeader

+ const OPTIONS

+ const PATCH

+ const PLAIN

+ const PLAINTEXT

+ const POST

+ const PROTOBUF

+ const PUT

+ const StatusBadRequest

+ const StatusForbidden

+ const StatusInternalServerError

+ const StatusNotFound

+ const StatusUnauthorized

+ const TRACE

+ const TRUE

+ const XML

+ const YAML

+ const YamlText

+ const YamlX

+ var DefaultAddr string = ":8080"

+ var DefaultErrorWriter io.Writer = os.Stderr

+ var DefaultPort int = 8080

+ var DefaultWriter io.Writer = os.Stdout

+ var ErrFailedToParseMultiPart = errors.New("failed to parse multipart data")

+ var ErrInvalidMultiPartData = errors.New("invalid multipart data")

+ var ErrNoRenderer = errors.New("no renderer set for context")

+ var ErrNotFound = errors.New("not found")

+ func GenerateJwtToken(secret []byte, claims jwt.MapClaims, ttl time.Duration) (string, error)

+ func RealIP(r *http.Request) string

+ func ValidateAddr(addr string) bool

+ type BasicAuthMiddleware struct

+ Password string

+ Realm string

+ Username string

+ func (b *BasicAuthMiddleware) Middleware(next HandleFunc) HandleFunc

+ type BodyLimit struct

+ MaxBytes int64

+ func (b BodyLimit) Middleware(next HandleFunc) HandleFunc

+ type Context struct

+ CtxData map[string]any

+ MaxMultipartMemory int64

+ Request *http.Request

+ Response Response

+ func (c *Context) AbortWithError(code int, err error) error

+ func (c *Context) Accept() []string

+ func (c *Context) AcceptLanguage() []string

+ func (c *Context) B(v any) error

+ func (c *Context) BadRequestError(message string)

+ func (c *Context) Bind(out any) error

+ func (c *Context) BindForm(v any) error

+ func (c *Context) BindJSON(v any) error

+ func (c *Context) BindMultipart(out any) error

+ func (c *Context) BindProtoBuf(v proto.Message) error

+ func (c *Context) BindQuery(v any) error

+ func (c *Context) BindXML(v any) error

+ func (c *Context) BindYAML(v any) error

+ func (c *Context) ContentType() string

+ func (c *Context) Cookie(name string) (string, error)

+ func (c *Context) Copy() *Context

+ func (c *Context) Data(code int, contentType string, data []byte) error

+ func (c *Context) Error(code int, message string) error

+ func (c *Context) Form(key string) string

+ func (c *Context) FormFile(key string) (*multipart.FileHeader, error)

+ func (c *Context) FormValue(key string) string

+ func (c *Context) Get(key string) (any, bool)

+ func (c *Context) GetBool(key string) bool

+ func (c *Context) GetInt(key string) int

+ func (c *Context) GetInt64(key string) int64

+ func (c *Context) GetString(key string) string

+ func (c *Context) GetTime(key string) (time.Time, bool)

+ func (c *Context) HTML(code int, file string, data any) error

+ func (c *Context) HTMLView(code int, templateStr string, data any) error

+ func (c *Context) Header(key string) string

+ func (c *Context) Headers() map[string][]string

+ func (c *Context) InternalServerError(message string)

+ func (c *Context) IsSSE() bool

+ func (c *Context) IsWebSocketUpgrade() bool

+ func (c *Context) JSON(code int, v any) error

+ func (c *Context) NotFoundError(message string)

+ func (c *Context) Param(key string) string

+ func (c *Context) Query(key string) string

+ func (c *Context) QueryMap() map[string]string

+ func (c *Context) RealIP() string

+ func (c *Context) Redirect(code int, location string)

+ func (c *Context) Referer() string

+ func (c *Context) Render(code int, name string, data interface{}) error

+ func (c *Context) ServeFile(path string)

+ func (c *Context) ServeFileAttachment(path, filename string)

+ func (c *Context) ServeFileFromFS(filepath string, fs http.FileSystem)

+ func (c *Context) ServeFileInline(path, filename string)

+ func (c *Context) Set(key string, value any)

+ func (c *Context) SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool)

+ func (c *Context) SetHeader(key, value string)

+ func (c *Context) ShouldBind(v any) (bool, error)

+ func (c *Context) String(code int, data any) error

+ func (c *Context) Text(code int, v any) error

+ func (c *Context) WriteStatus(code int)

+ func (c *Context) XML(code int, v any) error

+ func (c *Context) YAML(code int, data any) error

+ type Group struct

+ func (g *Group) BasePath() string

+ func (g *Group) Delete(path string, h HandleFunc) *Route

+ func (g *Group) Get(path string, h HandleFunc) *Route

+ func (g *Group) Group(path string, middlewares ...Middleware) *Group

+ func (g *Group) Head(path string, h HandleFunc) *Route

+ func (g *Group) Okapi() *Okapi

+ func (g *Group) Options(path string, h HandleFunc) *Route

+ func (g *Group) Patch(path string, h HandleFunc) *Route

+ func (g *Group) Post(path string, h HandleFunc) *Route

+ func (g *Group) Put(path string, h HandleFunc) *Route

+ func (g *Group) SetBasePath(basePath string)

+ func (g *Group) Trace(path string, h HandleFunc) *Route

+ func (g *Group) Use(m Middleware)

+ type HandleFunc func(c Context) error

+ func LoggerMiddleware(next HandleFunc) HandleFunc

+ type JWTAuth struct

+ ContextKey string

+ SecretKey []byte

+ TokenLookup string

+ func (j JWTAuth) Middleware(next HandleFunc) HandleFunc

+ func (j JWTAuth) ValidateToken(c Context) (jwt.MapClaims, error)

+ type Logger struct

+ type M map[string]any

+ type Message struct

+ Data any

+ Event string

+ ID string

+ func (s *Message) Close(w http.ResponseWriter) error

+ func (s *Message) Send(w http.ResponseWriter, data any, eventType string) (string, error)

+ type Middleware func(next HandleFunc) HandleFunc

+ type Okapi struct

+ Renderer Renderer

+ Server *http.Server

+ TLSServer *http.Server

+ func Default(options ...OptionFunc) *Okapi

+ func New(options ...OptionFunc) (e *Okapi)

+ func (o *Okapi) Any(path string, h HandleFunc) *Route

+ func (o *Okapi) Connect(path string, h HandleFunc) *Route

+ func (o *Okapi) Delete(path string, h HandleFunc) *Route

+ func (o *Okapi) Get(path string, h HandleFunc) *Route

+ func (o *Okapi) GetContext() *Context

+ func (o *Okapi) Group(path string, middlewares ...Middleware) *Group

+ func (o *Okapi) HandleFunc(method, path string, h HandleFunc)

+ func (o *Okapi) Head(path string, h HandleFunc) *Route

+ func (o *Okapi) Middlewares() []Middleware

+ func (o *Okapi) Next(h HandleFunc) HandleFunc

+ func (o *Okapi) Options(path string, h HandleFunc) *Route

+ func (o *Okapi) Patch(path string, h HandleFunc) *Route

+ func (o *Okapi) Post(path string, h HandleFunc) *Route

+ func (o *Okapi) Put(path string, h HandleFunc) *Route

+ func (o *Okapi) Routes() []Route

+ func (o *Okapi) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (o *Okapi) SetContext(ctx *Context)

+ func (o *Okapi) Shutdown(server *http.Server) error

+ func (o *Okapi) Start() error

+ func (o *Okapi) StartServer(server *http.Server) error

+ func (o *Okapi) Static(prefix string, dir string)

+ func (o *Okapi) StaticFS(prefix string, fs http.FileSystem)

+ func (o *Okapi) StaticFile(path string, filepath string)

+ func (o *Okapi) Stop()

+ func (o *Okapi) Trace(path string, h HandleFunc) *Route

+ func (o *Okapi) Use(middlewares ...Middleware)

+ func (o *Okapi) With(options ...OptionFunc) *Okapi

+ type OptionFunc func(*Okapi)

+ func WithAccessLogDisabled() OptionFunc

+ func WithAddr(addr string) OptionFunc

+ func WithDebug() OptionFunc

+ func WithLogger(logger *slog.Logger) OptionFunc

+ func WithMux(mux *mux.Router) OptionFunc

+ func WithPort(port int) OptionFunc

+ func WithServer(server *http.Server) OptionFunc

+ func WithStrictSlash(strict bool) OptionFunc

+ func WithTLSServer(server *http.Server) OptionFunc

+ type Param struct

+ Param struct{ ... }

+ type Params []Param

+ func (p *Params) Get(key string) (string, bool)

+ type Renderer interface

+ Render func(io.Writer, string, interface{}, Context) error

+ type RendererFunc func(io.Writer, string, interface{}, Context) error

+ func (f RendererFunc) Render(w io.Writer, name string, data interface{}, c Context) error

+ type Response interface

+ BodyBytesSent func() int

+ Close func()

+ Hijack func() (net.Conn, *bufio.ReadWriter, error)

+ Status func() int

+ type Route struct

+ Handle HandleFunc

+ Method string

+ Name string

+ Path string

+ type Router struct

+ type Send func(data any, eventType string) (string, error)

+ type ValidateFunc func(data any) error

+ func (vf ValidateFunc) Validate(data any) error

+ type Validator interface

+ Validate func(data any) error