fiberoapi

Mar 13, 2026

Changes in this version

type OpenAPIOptions

+ RequireAllRoles bool

+ func WithAllRoles(options OpenAPIOptions, roles ...string) OpenAPIOptions

Mar 13, 2026

Changes in this version

+ type AuthErrorHandler func(c *fiber.Ctx, err *AuthError) error

type Config

+ AuthErrorHandler AuthErrorHandler

Mar 13, 2026

Changes in this version

type OpenAPIOptions

+ RequiredRoles []string

+ func WithRoles(options OpenAPIOptions, roles ...string) OpenAPIOptions

Feb 10, 2026

Changes in this version

+ func APIKeyMiddleware(validator AuthorizationService, scheme SecurityScheme) fiber.Handler

+ func AWSSignatureMiddleware(validator AuthorizationService) fiber.Handler

+ func BasicAuthMiddleware(validator AuthorizationService) fiber.Handler

+ func MultiSchemeAuthMiddleware(authService AuthorizationService, config Config) fiber.Handler

+ type APIKeyValidator interface

+ ValidateAPIKey func(key string, location string, paramName string) (*AuthContext, error)

+ type AWSSignatureParams struct

+ AccessKeyID string

+ Body []byte

+ Date string

+ Headers map[string]string

+ Method string

+ Path string

+ QueryString string

+ RawHeader string

+ Region string

+ Service string

+ Signature string

+ SignedHeaders []string

+ type AWSSignatureValidator interface

+ ValidateAWSSignature func(params *AWSSignatureParams) (*AuthContext, error)

+ type AuthError struct

+ Message string

+ StatusCode int

+ func (e *AuthError) Error() string

+ type BasicAuthValidator interface

+ ValidateBasicAuth func(username, password string) (*AuthContext, error)

+ type ScopeError struct

+ Scope string

+ func (e *ScopeError) Error() string

Dec 2, 2025

Changes in this version

type Config

+ ValidationErrorHandler ValidationErrorHandler

+ type ValidationErrorHandler func(c *fiber.Ctx, err error) error

Sep 29, 2025

Changes in this version

type Config

+ OpenAPIYamlPath string

type DocConfig

+ YamlPath string

type OApiApp

+ func (o *OApiApp) GenerateOpenAPISpecYAML() (string, error)

Sep 14, 2025

Changes in this version

+ func BearerTokenMiddleware(validator AuthorizationService) fiber.Handler

+ func ConditionalAuthMiddleware(authMiddleware fiber.Handler, excludePaths ...string) fiber.Handler

+ func RequireResourceAccess(c *fiber.Ctx, authService AuthorizationService, ...) error

+ func RoleGuard(validator AuthorizationService, requiredRoles ...string) fiber.Handler

+ func SmartAuthMiddleware(authService AuthorizationService, config Config) fiber.Handler

+ type AuthContext struct

+ Claims map[string]interface{}

+ Roles []string

+ Scopes []string

+ UserID string

+ func GetAuthContext(c *fiber.Ctx) (*AuthContext, error)

+ type AuthorizationService interface

+ CanAccessResource func(ctx *AuthContext, resourceType, resourceID, action string) (bool, error)

+ GetUserPermissions func(ctx *AuthContext, resourceType, resourceID string) (*ResourcePermission, error)

+ HasRole func(ctx *AuthContext, role string) bool

+ HasScope func(ctx *AuthContext, scope string) bool

+ ValidateToken func(token string) (*AuthContext, error)

type Config

+ AuthService AuthorizationService

+ DefaultSecurity []map[string][]string

+ EnableAuthorization bool

+ SecuritySchemes map[string]SecurityScheme

type OApiApp

+ func (o *OApiApp) Listen(addr string) error

+ func (o *OApiApp) Use(middleware fiber.Handler)

type OApiGroup

+ func (g *OApiGroup) Use(middleware fiber.Handler)

type OpenAPIOptions

+ RequiredPermissions []string

+ ResourceType string

+ func WithPermissions(options OpenAPIOptions, permissions ...string) OpenAPIOptions

+ func WithResourceType(options OpenAPIOptions, resourceType string) OpenAPIOptions

+ func WithSecurity(options OpenAPIOptions, security interface{}) OpenAPIOptions

+ func WithSecurityDisabled(options OpenAPIOptions) OpenAPIOptions

+ type ResourcePermission struct

+ Actions []string

+ ResourceID string

+ ResourceType string

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ Flows map[string]interface{}

+ In string

+ Name string

+ Scheme string

+ Type string

Aug 31, 2025

Changes in this version

+ type ErrorResponse struct

+ Code int

+ Details string

+ Type string

Aug 31, 2025

Changes in this version

+ func Delete[TInput any, TOutput any, TError any](router OApiRouter, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func Get[TInput any, TOutput any, TError any](router OApiRouter, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func Head[TInput any, TOutput any, TError any](router OApiRouter, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func Method[TInput any, TOutput any, TError any](router OApiRouter, m string, path string, ...)

+ func Patch[TInput any, TOutput any, TError any](router OApiRouter, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func Post[TInput any, TOutput any, TError any](router OApiRouter, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func Put[TInput any, TOutput any, TError any](router OApiRouter, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

type OApiApp

+ func (app *OApiApp) Group(prefix string, handlers ...fiber.Handler) *OApiGroup

+ func (o *OApiApp) GetApp() *OApiApp

+ func (o *OApiApp) GetPrefix() string

+ type OApiGroup struct

+ func Group(router OApiRouter, prefix string, handlers ...fiber.Handler) *OApiGroup

+ func (g *OApiGroup) GetApp() *OApiApp

+ func (g *OApiGroup) GetPrefix() string

+ func (g *OApiGroup) Group(prefix string, handlers ...fiber.Handler) *OApiGroup

+ type OApiRouter interface

+ GetApp func() *OApiApp

+ GetPrefix func() string

Aug 30, 2025

Changes in this version

+ func DeleteOApi[TInput any, TOutput any, TError any](o *OApiApp, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func GetOApi[TInput any, TOutput any, TError any](o *OApiApp, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func PostOApi[TInput any, TOutput any, TError any](o *OApiApp, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ func PutOApi[TInput any, TOutput any, TError any](o *OApiApp, path string, handler HandlerFunc[TInput, TOutput, TError], ...)

+ type Config struct

+ EnableOpenAPIDocs bool

+ EnableValidation bool

+ OpenAPIDocsPath string

+ OpenAPIJSONPath string

+ func DefaultConfig() Config

+ type DocConfig struct

+ Description string

+ DocsPath string

+ JSONPath string

+ Title string

+ Version string

+ func DefaultDocConfig() DocConfig

+ type HandlerFunc func(c *fiber.Ctx, input TInput) (TOutput, TError)

+ type OApiApp struct

+ func New(app *fiber.App, config ...Config) *OApiApp

+ func (o *OApiApp) Config() Config

+ func (o *OApiApp) GenerateOpenAPISpec() map[string]interface{}

+ func (o *OApiApp) GetOperations() []OpenAPIOperation

+ func (o *OApiApp) SetupDocs(config ...DocConfig)

+ type OpenAPIOperation struct

+ ErrorType reflect.Type

+ InputType reflect.Type

+ Method string

+ Options OpenAPIOptions

+ OutputType reflect.Type

+ Path string

+ type OpenAPIOptions struct

+ Description string

+ OperationID string

+ Parameters []OpenAPIParameter

+ RequestBody *OpenAPIRequestBody

+ Responses map[string]OpenAPIResponse

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type OpenAPIParameter struct

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema map[string]interface{}

+ type OpenAPIRequestBody struct

+ Content map[string]interface{}

+ Description string

+ Required bool

+ type OpenAPIResponse struct

+ Content map[string]interface{}

+ Description string

+ type PathInfo struct

+ Index int

+ IsPath bool

+ Name string