Documentation
¶
Overview ¶
Package api provides api handlers for web requests.
Index ¶
- type API
- func (a *API) MakeDeleteZettelHandler(deleteZettel *usecase.DeleteZettel) http.Handler
- func (a *API) MakeGetDataHandler(ucVersion usecase.Version) http.Handler
- func (a *API) MakeGetReferencesHandler(ucParseZettel usecase.ParseZettel, ucGetReferences usecase.GetReferences) http.Handler
- func (a *API) MakeGetZettelHandler(getZettel usecase.GetZettel, parseZettel usecase.ParseZettel, ...) http.Handler
- func (a *API) MakePostCommandHandler(ucIsAuth *usecase.IsAuthenticated, ucRefresh *usecase.Refresh) http.Handler
- func (a *API) MakePostCreateZettelHandler(createZettel *usecase.CreateZettel) http.Handler
- func (a *API) MakePostLoginHandler(ucAuth *usecase.Authenticate) http.Handler
- func (a *API) MakeQueryHandler(queryMeta *usecase.Query, tagZettel *usecase.TagZettel, ...) http.Handler
- func (a *API) MakeRenewAuthHandler() http.Handler
- func (a *API) MakeUpdateZettelHandler(updateZettel *usecase.UpdateZettel) http.Handler
- func (a *API) NewURLBuilder(key byte) *api.URLBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API holds all data and methods for delivering API call results.
func New ¶
func New(logger *slog.Logger, b server.Builder, authz auth.AuthzManager, token auth.TokenManager, rtConfig config.Config, pol auth.Policy) *API
New creates a new API object.
func (*API) MakeDeleteZettelHandler ¶
func (a *API) MakeDeleteZettelHandler(deleteZettel *usecase.DeleteZettel) http.Handler
MakeDeleteZettelHandler creates a new HTTP handler to delete a zettel.
func (*API) MakeGetDataHandler ¶
MakeGetDataHandler creates a new HTTP handler to return zettelstore data.
func (*API) MakeGetReferencesHandler ¶
func (a *API) MakeGetReferencesHandler( ucParseZettel usecase.ParseZettel, ucGetReferences usecase.GetReferences, ) http.Handler
MakeGetReferencesHandler creates a new HTTP handler to return various lists of zettel references.
func (*API) MakeGetZettelHandler ¶
func (a *API) MakeGetZettelHandler( getZettel usecase.GetZettel, parseZettel usecase.ParseZettel, evaluate usecase.Evaluate, ) http.Handler
MakeGetZettelHandler creates a new HTTP handler to return a zettel in various encodings.
func (*API) MakePostCommandHandler ¶
func (a *API) MakePostCommandHandler( ucIsAuth *usecase.IsAuthenticated, ucRefresh *usecase.Refresh, ) http.Handler
MakePostCommandHandler creates a new HTTP handler to execute certain commands.
func (*API) MakePostCreateZettelHandler ¶
func (a *API) MakePostCreateZettelHandler(createZettel *usecase.CreateZettel) http.Handler
MakePostCreateZettelHandler creates a new HTTP handler to store content of an existing zettel.
func (*API) MakePostLoginHandler ¶
func (a *API) MakePostLoginHandler(ucAuth *usecase.Authenticate) http.Handler
MakePostLoginHandler creates a new HTTP handler to authenticate the given user via API.
func (*API) MakeQueryHandler ¶
func (a *API) MakeQueryHandler( queryMeta *usecase.Query, tagZettel *usecase.TagZettel, roleZettel *usecase.RoleZettel, reIndex *usecase.ReIndex, ) http.Handler
MakeQueryHandler creates a new HTTP handler to perform a query.
func (*API) MakeRenewAuthHandler ¶
MakeRenewAuthHandler creates a new HTTP handler to renew the authenticate of a user.
func (*API) MakeUpdateZettelHandler ¶
func (a *API) MakeUpdateZettelHandler(updateZettel *usecase.UpdateZettel) http.Handler
MakeUpdateZettelHandler creates a new HTTP handler to update a zettel.
func (*API) NewURLBuilder ¶
func (a *API) NewURLBuilder(key byte) *api.URLBuilder
NewURLBuilder creates a new URL builder object with the given key.
Source Files