apis

Documentation

Index

• Constants
• func AlbumNotFound() *api.Error
• func ArtistNotFound() *api.Error
• func Body[T types.Body](c echo.Context) (T, error)
• func InstallAlbumHandlers(app core.App, group Group)
• func InstallArtistHandlers(app core.App, group Group)
• func InstallAuthHandlers(app core.App, group Group)
• func InstallHandlers(app core.App, g Group)
• func InstallPlaylistHandlers(app core.App, group Group)
• func InstallQueueHandlers(app core.App, group Group)
• func InstallSyncHandlers(app core.App, group Group)
• func InstallSystemHandlers(app core.App, group Group)
• func InstallTagHandlers(app core.App, group Group)
• func InstallTrackHandlers(app core.App, group Group)
• func InvalidFilter(err error) *api.Error
• func InvalidSort(err error) *api.Error
• func RequireSetup(app core.App) echo.MiddlewareFunc
• func RouteNotFound() *api.Error
• func Server(app core.App) (*echo.Echo, error)
• func SuccessResponse(data any) api.Response
• func TrackNotFound() *api.Error
• func User(app core.App, c echo.Context) (*database.User, error)
• type Group
• type Handler

Constants

const (
	ErrTypeArtistNotFound api.ErrorType = "ARTIST_NOT_FOUND"
	ErrTypeAlbumNotFound  api.ErrorType = "ALBUM_NOT_FOUND"
	ErrTypeTrackNotFound  api.ErrorType = "TRACK_NOT_FOUND"
	ErrTypeRouteNotFound  api.ErrorType = "ROUTE_NOT_FOUND"
	ErrTypeInvalidFilter  api.ErrorType = "INVALID_FILTER"
	ErrTypeInvalidSort    api.ErrorType = "INVALID_SORT"
)

const ErrTypeUnknownError api.ErrorType = "UNKNOWN_ERROR"

Functions

func AlbumNotFound

func AlbumNotFound() *api.Error

func ArtistNotFound

func ArtistNotFound() *api.Error

func Body

func Body[T types.Body](c echo.Context) (T, error)

func InstallAlbumHandlers

func InstallAlbumHandlers(app core.App, group Group)

func InstallArtistHandlers

func InstallArtistHandlers(app core.App, group Group)

func InstallAuthHandlers

func InstallAuthHandlers(app core.App, group Group)

func InstallHandlers

func InstallHandlers(app core.App, g Group)

func InstallPlaylistHandlers

func InstallPlaylistHandlers(app core.App, group Group)

func InstallQueueHandlers

func InstallQueueHandlers(app core.App, group Group)

func InstallSyncHandlers

func InstallSyncHandlers(app core.App, group Group)

func InstallSystemHandlers

func InstallSystemHandlers(app core.App, group Group)

func InstallTagHandlers

func InstallTagHandlers(app core.App, group Group)

func InstallTrackHandlers

func InstallTrackHandlers(app core.App, group Group)

func InvalidFilter

func InvalidFilter(err error) *api.Error

func InvalidSort

func InvalidSort(err error) *api.Error

func RequireSetup

func RequireSetup(app core.App) echo.MiddlewareFunc

func RouteNotFound

func RouteNotFound() *api.Error

func Server

func Server(app core.App) (*echo.Echo, error)

func SuccessResponse

func SuccessResponse(data any) api.Response

func TrackNotFound

func TrackNotFound() *api.Error

func User

func User(app core.App, c echo.Context) (*database.User, error)

Types

type Group

type Group interface {
	Register(handlers ...Handler)
}

type Handler

type Handler struct {
	Name        string
	Method      string
	Path        string
	DataType    any
	BodyType    types.Body
	Errors      []api.ErrorType
	HandlerFunc echo.HandlerFunc
	Middlewares []echo.MiddlewareFunc
}