arc

package module

Go to main page

Versions in this module

v0

v0.1.1

Mar 8, 2026

Changes in this version

+ func ValidateOpenAPIQuality(spec map[string]any, gates OpenAPIQualityGates) []string

type Engine

+ func (e *Engine) AddOpenAPIServer(url, description string)

+ func (e *Engine) OpenAPISpec() map[string]any

+ func (e *Engine) RegisterOpenAPISecurityScheme(name string, scheme map[string]any)

+ func (e *Engine) SetOpenAPIServers(servers []map[string]any)

+ type OpenAPIQualityGates struct

+ RequireExamples bool

+ RequireRootTags bool

+ RequireServers bool

+ RequiredSecuritySchemes []string

type Operation

+ ProblemExamples map[int]map[string]any

+ ProblemStatuses []int

+ RequestExamples map[string]any

+ ResponseExamples map[string]any

type OperationRegistry

+ func (r *OperationRegistry) RegisterSecurityScheme(name string, scheme map[string]any)

+ func (r *OperationRegistry) SetServers(servers []map[string]any)

+ type ProblemExampleSpec struct

+ Code string

+ Detail string

type RouteOption

+ func WithProblemResponseSpec(spec map[int]ProblemExampleSpec) RouteOption

+ func WithProblemResponses(statuses ...int) RouteOption

+ func WithRequestExamples(examples map[string]any) RouteOption

+ func WithResponseExamples(examples map[string]any) RouteOption

v0.1.0

Mar 8, 2026

Changes in this version

+ var EnableLegacyTagSync = true

+ func APIVersionFromContext(ctx context.Context) (string, bool)

+ func CacheControlHeaders(maxAge time.Duration) http.Header

+ func ConfigureFieldMetadata(model any, fieldGoName string, cfg FieldMetadataConfig) error

+ func DefaultDocsHTML(openapiPath string) string

+ func FlattenIncludeTree(tree IncludeTree) []string

+ func HandleErr[Input any](e *Engine, method, path, operationID string, ...)

+ func HandleGroup[Input any, Output any](g *Group, method, path, operationID string, ...)

+ func HandleOut[Input any, Output any](e *Engine, method, path, operationID string, ...)

+ func HandleRawTyped[Input any](e *Engine, method, path, operationID string, ...)

+ func HandleSSE[Input any](e *Engine, method, path, operationID string, ...)

+ func HandleStreamTyped[Input any](e *Engine, method, path, operationID string, ...)

+ func HandleWebSocket[Input any](e *Engine, method, path, operationID string, cfg WSConfig, ...)

+ func Handle[Input any, Output any](e *Engine, method, path, operationID string, ...)

+ func HasInclude(ctx context.Context, path string) bool

+ func IncludesFromContext(ctx context.Context) []string

+ func ParseIncludes(raw string, allowlist []string) ([]string, error)

+ func RegisterValidator[T any](e *Engine, fn func(*T) error)

+ func TenantFromContext(ctx context.Context) (string, bool)

+ func WithAPIVersion(ctx context.Context, version string) context.Context

+ func WithIncludes(ctx context.Context, includes []string) context.Context

+ func WithListQueryDTO(ctx context.Context, dto ListQueryDTO) context.Context

+ type APIError struct

+ Code string

+ Details []ErrorDetail

+ Message string

+ RequestID string

+ Status int

+ func BadRequest(code, message string) *APIError

+ func Validation(code, message string) *APIError

+ func (e *APIError) Error() string

+ type APIVersionSource string

+ const APIVersionSourceAccept

+ const APIVersionSourceHeader

+ const APIVersionSourceQuery

+ type APIVersioningConfig struct

+ AcceptParam string

+ DefaultVersion string

+ Header string

+ QueryParam string

+ Required bool

+ ResponseHeader string

+ Sources []APIVersionSource

+ type CacheConfig struct

+ SkipAuthorized bool

+ SkipCookies bool

+ Store *ResponseCache

+ TTL time.Duration

+ VaryHeaders []string

+ type CacheInvalidationConfig struct

+ ClearOnAnyMatch bool

+ InvalidateRequestPath bool

+ Methods []string

+ PathPrefixResolver func(*http.Request) []string

+ PathPrefixes []string

+ Store *ResponseCache

+ type Encoder interface

+ Encode func(w http.ResponseWriter, status int, body any) error

+ type Engine struct

+ func New() *Engine

+ func (e *Engine) AddObserver(obs Observer)

+ func (e *Engine) Group(prefix string, middleware ...Middleware) *Group

+ func (e *Engine) IsReady() bool

+ func (e *Engine) MarshalOpenAPIJSON() ([]byte, error)

+ func (e *Engine) MarshalOpenAPIYAML() ([]byte, error)

+ func (e *Engine) Operations() []Operation

+ func (e *Engine) RegisterEncoder(contentType string, enc Encoder)

+ func (e *Engine) RegisterHealthRoutes()

+ func (e *Engine) RegisterRaw(method, path, operationID string, h Handler, middleware ...Middleware)

+ func (e *Engine) RegisterSchemaRoutes(listPath, itemPath string)

+ func (e *Engine) RegisterSystemRoutes(openapiPath, docsPath string)

+ func (e *Engine) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (e *Engine) SetEncoder(enc Encoder)

+ func (e *Engine) SetErrorMapper(m ErrorMapper)

+ func (e *Engine) SetReady(v bool)

+ func (e *Engine) Use(mw ...Middleware)

+ func (e *Engine) Version(version string, middleware ...Middleware) *Group

+ type ErrorDetail struct

+ Code string

+ Message string

+ Path string

+ type ErrorMapper interface

+ MapError func(err error) *APIError

+ type FieldMetadataConfig struct

+ Cookie string

+ Form string

+ Header string

+ Path string

+ Query string

+ Validate string

+ type Group struct

+ func (g *Group) Group(prefix string, middleware ...Middleware) *Group

+ func (g *Group) WithAcceptVersioning(param string, required bool, defaultVersion string) *Group

+ func (g *Group) WithCallbacks(callbacks map[string]any) *Group

+ func (g *Group) WithHeaderVersioning(header string, required bool, defaultVersion string) *Group

+ func (g *Group) WithIncludeAllowlist(paths ...string) *Group

+ func (g *Group) WithIncludeParamName(name string) *Group

+ func (g *Group) WithMetadata(items map[string]string) *Group

+ func (g *Group) WithQueryDTO() *Group

+ func (g *Group) WithQueryVersioning(param string, required bool, defaultVersion string) *Group

+ func (g *Group) WithSecurity(items ...string) *Group

+ func (g *Group) WithTags(tags ...string) *Group

+ func (g *Group) WithVersion(version string) *Group

+ func (g *Group) WithVersioning(cfg APIVersioningConfig) *Group

+ type HMACJWTVerifier struct

+ func NewHMACJWTVerifier(secret []byte, allowedAlgs ...string) *HMACJWTVerifier

+ func (v *HMACJWTVerifier) VerifyAndParse(token string) (map[string]any, error)

+ func (v *HMACJWTVerifier) WithLeeway(d time.Duration) *HMACJWTVerifier

+ type Handler func(*RequestContext) error

+ type IncludeTree map[string]IncludeTree

+ func BuildIncludeTree(includes []string) IncludeTree

+ func IncludeTreeFromContext(ctx context.Context) IncludeTree

+ type JSONEncoder struct

+ func (JSONEncoder) Encode(w http.ResponseWriter, status int, body any) error

+ type JWTVerifier interface

+ VerifyAndParse func(token string) (map[string]any, error)

+ type ListQueryDTO struct

+ Filters map[string][]string

+ Include []string

+ Limit *int

+ Offset *int

+ Sort []SortField

+ func QueryDTOFromContext(ctx context.Context) (ListQueryDTO, bool)

+ type Middleware func(Handler) Handler

+ func APIVersioning(cfg APIVersioningConfig) Middleware

+ func CacheResponses(ttl time.Duration) Middleware

+ func CacheResponsesWithConfig(cfg CacheConfig) Middleware

+ func InvalidateCacheOnWrite(cfg CacheInvalidationConfig) Middleware

+ func Logger(logger *log.Logger) Middleware

+ func Recovery() Middleware

+ func TenantExtractor(extractors ...TenantResolveFunc) Middleware

+ type Observer interface

+ OnRequestEnd func(*RequestContext, int, error, time.Duration)

+ OnRequestStart func(*RequestContext)

+ type ObserverFunc struct

+ End func(*RequestContext, int, error, time.Duration)

+ Start func(*RequestContext)

+ func (o ObserverFunc) OnRequestEnd(rc *RequestContext, status int, err error, d time.Duration)

+ func (o ObserverFunc) OnRequestStart(rc *RequestContext)

+ type Operation struct

+ Callbacks map[string]any

+ Handler Handler

+ HasFormBody bool

+ HasQueryDTO bool

+ HasRequestBody bool

+ IncludeAllowlist []string

+ IncludeParamName string

+ InputContentType string

+ InputType any

+ Metadata map[string]string

+ Method string

+ Middleware []Middleware

+ MiddlewareN int

+ OperationID string

+ OutputType any

+ Params []OperationParam

+ Path string

+ ResponseKind responseKind

+ Security []string

+ Tags []string

+ Version string

+ type OperationParam struct

+ In string

+ Name string

+ Required bool

+ Schema map[string]any

+ type OperationRegistry struct

+ func NewOperationRegistry() *OperationRegistry

+ func (r *OperationRegistry) Add(op Operation)

+ func (r *OperationRegistry) JSONSchemaForType(model any) map[string]any

+ func (r *OperationRegistry) JSONSchemas() map[string]any

+ func (r *OperationRegistry) List() []Operation

+ func (r *OperationRegistry) MarshalJSONSchemasJSON() ([]byte, error)

+ func (r *OperationRegistry) MarshalOpenAPIJSON() ([]byte, error)

+ func (r *OperationRegistry) MarshalOpenAPIYAML() ([]byte, error)

+ func (r *OperationRegistry) OpenAPISpec() map[string]any

+ func (r *OperationRegistry) Update(method, path, operationID string, fn func(*Operation))

+ type Optional struct

+ func Null[T any]() Optional[T]

+ func Some[T any](v T) Optional[T]

+ func (o *Optional[T]) Set(v T)

+ func (o *Optional[T]) SetNull()

+ func (o *Optional[T]) UnmarshalJSON(data []byte) error

+ func (o *Optional[T]) UnmarshalText(text []byte) error

+ func (o *Optional[T]) Unset()

+ func (o Optional[T]) IsNull() bool

+ func (o Optional[T]) IsSet() bool

+ func (o Optional[T]) IsZero() bool

+ func (o Optional[T]) MarshalJSON() ([]byte, error)

+ func (o Optional[T]) OptionalIsNull() bool

+ func (o Optional[T]) OptionalIsSet() bool

+ func (o Optional[T]) OptionalValueAny() any

+ func (o Optional[T]) Value() (T, bool)

+ type OptionalBool = Optional[bool]

+ type OptionalInt = Optional[int]

+ type OptionalString = Optional[string]

+ type RawResponse struct

+ Headers http.Header

+ Status int

+ WriteTo func(http.ResponseWriter) error

+ func File(status int, filename string, content []byte) *RawResponse

+ func Raw(status int, contentType string, body []byte) *RawResponse

+ type RequestContext struct

+ Ctx context.Context

+ Engine *Engine

+ Params map[string]string

+ Request *http.Request

+ Writer http.ResponseWriter

+ type Response struct

+ Body *T

+ Headers http.Header

+ Status int

+ func Created[T any](body T) *Response[T]

+ func JSON[T any](status int, body T) *Response[T]

+ func NoContent() *Response[struct{}]

+ func OK[T any](body T) *Response[T]

+ type ResponseCache struct

+ func NewResponseCache() *ResponseCache

+ func (c *ResponseCache) Clear()

+ func (c *ResponseCache) InvalidatePathPrefix(prefix string)

+ type Route struct

+ Handler Handler

+ Middleware []Middleware

+ type RouteOption func(*routeConfig)

+ func WithCallbacks(callbacks map[string]any) RouteOption

+ func WithIncludeAllowlist(paths ...string) RouteOption

+ func WithIncludeParamName(name string) RouteOption

+ func WithMetadata(items map[string]string) RouteOption

+ func WithMiddleware(mw ...Middleware) RouteOption

+ func WithQueryDTO() RouteOption

+ func WithSecurity(items ...string) RouteOption

+ func WithTags(tags ...string) RouteOption

+ func WithVersion(version string) RouteOption

+ type Router struct

+ func NewRouter() *Router

+ func (r *Router) Add(method, path string, route Route)

+ func (r *Router) AllowedMethods(path string) []string

+ func (r *Router) Match(method, path string) (Route, map[string]string, bool)

+ type SSEEvent struct

+ Data string

+ Event string

+ ID string

+ Retry time.Duration

+ type SSEWriter struct

+ func NewSSEWriter(w http.ResponseWriter) (*SSEWriter, error)

+ func (s *SSEWriter) WriteEvent(ev SSEEvent) error

+ type Server struct

+ func NewServer(addr string, engine *Engine) *Server

+ func (s *Server) Shutdown(ctx context.Context) error

+ func (s *Server) Start() error

+ type SortField struct

+ Desc bool

+ Field string

+ type StreamResponse struct

+ ContentType string

+ Reader io.Reader

+ Status int

+ func Stream(status int, contentType string, reader io.Reader) *StreamResponse

+ type StructValidatorFunc func(any) error

+ type TenantResolveFunc func(*RequestContext) (string, bool)

+ func TenantFromCookie(name string) TenantResolveFunc

+ func TenantFromHeader(name string) TenantResolveFunc

+ func TenantFromJWTClaim(claim string) TenantResolveFunc

+ func TenantFromPath(param string) TenantResolveFunc

+ func TenantFromVerifiedJWTClaim(claim string, verifier JWTVerifier) TenantResolveFunc

+ type ValidationErrors struct

+ Details []ErrorDetail

+ func (e *ValidationErrors) Error() string

+ type WSConfig struct

+ CheckOrigin func(*http.Request) bool

+ type WSConn struct

+ Conn *websocket.Conn

+ func (c *WSConn) Close() error

+ func (c *WSConn) ReadText() (string, error)

+ func (c *WSConn) WriteText(msg string) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL