router

Documentation

Index

• type Router
  • func New(ctx context.Context, cfg *config.Config, db db.DB) (Router, error)

Types

type Router

type Router interface {
	// Attach a gin handler to the router with the given method and path
	AttachHandler(method string, path string, f gin.HandlerFunc)
	// Attach a gin middleware to the router that will be used globally
	AttachMiddleware(handler gin.HandlerFunc)
	// Attach 404 NoRoute handler
	AttachNoRouteHandler(handler gin.HandlerFunc)
	// Add Gin StaticFile handler
	AttachStaticFS(relativePath string, fs http.FileSystem)
	// Start the router
	Start()
	// Stop the router
	Stop(ctx context.Context) error
}

Router provides the REST interface for gotosocial, using gin.

func New

func New(ctx context.Context, cfg *config.Config, db db.DB) (Router, error)

New returns a new Router with the specified configuration.

The given DB is only used in the New function for parsing config values, and is not otherwise pinned to the router.