api

Documentation

Index

• type ClientModule
• type FederationModule

Types

type ClientModule

type ClientModule interface {
	Route(s router.Router) error
}

ClientModule represents a chunk of code (usually contained in a single package) that adds a set of functionalities and/or side effects to a router, by mapping routes and/or middlewares onto it--in other words, a REST API ;) A ClientAPIMpdule with routes corresponds roughly to one main path of the gotosocial REST api, for example /api/v1/accounts/ or /oauth/

type FederationModule

type FederationModule interface {
	Route(s router.Router) error
}

FederationModule represents a chunk of code (usually contained in a single package) that adds a set of functionalities and/or side effects to a router, by mapping routes and/or middlewares onto it--in other words, a REST API ;) Unlike ClientAPIModule, federation API module is not intended to be interacted with by clients directly -- it is primarily a server-to-server interface.