api

Documentation

Overview

Package api implements the /api/v1/ REST handlers for monbooru.

Index

• type Gallery
• type Handler
  • func New(cfg *config.Config, jobManager *jobs.Manager, resolver ResolverFunc, ...) *Handler
  • func (h *Handler) Mount(mux *http.ServeMux)
• type ResolverFunc

Types

type Gallery

type Gallery struct {
	Name             string
	GalleryPath      string
	ThumbnailsPath   string
	DB               *db.DB
	TagSvc           *tags.Service
	RelationsSvc     *relations.Service
	InvalidateCaches func()
	// VisibleCount / TagCount return the cached non-missing-image and
	// non-alias-tag counts (the same values the Settings page shows). May
	// be nil; listGalleries falls back to a direct query then.
	VisibleCount func() (int, error)
	TagCount     func() (int, error)
}

Gallery is what API handlers need to act on a single gallery. InvalidateCaches is called after every image add/delete; may be nil.

type Handler

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

Handler is the root handler for all /api/v1/ routes.

func New

func New(cfg *config.Config, jobManager *jobs.Manager, resolver ResolverFunc, version string) *Handler

New creates a new API handler. version is surfaced on the /api/v1/ root so clients (e.g. monloader) can read the server version without scraping HTML.

func (*Handler) Mount

func (h *Handler) Mount(mux *http.ServeMux)

Mount registers every API route on mux under /api/v1/.

type ResolverFunc

type ResolverFunc func(name string) (Gallery, bool)

ResolverFunc resolves a gallery by name. Empty name = active gallery.