api

Documentation

Index

• func AboutHandler(c echo.Context) error
• func DisablePocketAdminAPI() echo.MiddlewareFunc
• func GenerateNumbersHandler(app *pocketbase.PocketBase) func(c echo.Context) error
• func JSONContentTypeMiddleware(next http.Handler) http.Handler
• func LoggerMiddleWare(next http.Handler) http.Handler
• func RootHandler(routes []Route) func(c echo.Context) error
• func SetupRoutes()
• type Info
• type Route

Functions

func AboutHandler

func AboutHandler(c echo.Context) error

AboutHandler handles requests to /api/v1/about/

func DisablePocketAdminAPI

func DisablePocketAdminAPI() echo.MiddlewareFunc

func GenerateNumbersHandler

func GenerateNumbersHandler(app *pocketbase.PocketBase) func(c echo.Context) error

func JSONContentTypeMiddleware

func JSONContentTypeMiddleware(next http.Handler) http.Handler

func LoggerMiddleWare

func LoggerMiddleWare(next http.Handler) http.Handler

func RootHandler

func RootHandler(routes []Route) func(c echo.Context) error

RoodHandler handles requests to /api/v1/ route

func SetupRoutes

func SetupRoutes()

SetupRoutes configures the routes for our API

Types

type Info

type Info struct {
	Name        string `json:"name"`
	Version     string `json:"version"`
	Description string `json:"description"`
}

APIInfo type holds details about API.

type Route

type Route struct {
	Path        string `json:"path"`
	Method      string `json:"method"`
	Description string `json:"description"`
}

Route type holds details about different endpoints that can be used.