routes

Documentation

Overview

Package routes contains route handlers and logic for identity-api.

Package routes provides the routes for the application.

Index

• func SkipNoAuthRoutes(c echo.Context) bool
• type Option
  • func WithAuditMiddleware(mw *echoaudit.Middleware) Option
  • func WithIssuer(issuer string) Option
  • func WithLogger(logger *zap.SugaredLogger) Option
  • func WithOauthConfig(config fositex.OAuth2Configurator) Option
  • func WithProvider(provider fosite.OAuth2Provider) Option
• type Router
  • func NewRouter(opts ...Option) *Router
  • func (r *Router) Routes(rg *echo.Group)

Functions

func SkipNoAuthRoutes

func SkipNoAuthRoutes(c echo.Context) bool

SkipNoAuthRoutes returns true if the requesting path should not have auth validated for it.

Types

type Option

type Option func(r *Router)

Option is a functional configuration option for the router

func WithAuditMiddleware

func WithAuditMiddleware(mw *echoaudit.Middleware) Option

WithAuditMiddleware sets the audit middleware for the router

func WithIssuer

func WithIssuer(issuer string) Option

WithIssuer sets the issuer for the router

func WithLogger

func WithLogger(logger *zap.SugaredLogger) Option

WithLogger sets the logger for the router

func WithOauthConfig

func WithOauthConfig(config fositex.OAuth2Configurator) Option

WithOauthConfig sets the fosite oauth2 configurator for the router

func WithProvider

func WithProvider(provider fosite.OAuth2Provider) Option

WithProvider sets the fosite provider for the router

type Router

type Router struct {
	// contains filtered or unexported fields
}

Router is the router for the application.

func NewRouter

func NewRouter(opts ...Option) *Router

NewRouter creates a new router

func (*Router) Routes

func (r *Router) Routes(rg *echo.Group)

Routes registers the routes for the application.