example

Documentation

Index

• Variables
• type DocumentsHandler
  • func NewDocuments(log *zap.Logger, mon *monkit.Scope, service DocumentsService, ...) *DocumentsHandler
• type DocumentsService
• type UsersHandler
  • func NewUsers(log *zap.Logger, mon *monkit.Scope, service UsersService, router *mux.Router, ...) *UsersHandler
• type UsersService

Variables

var ErrDocsAPI = errs.Class("example docs api")

var ErrUsersAPI = errs.Class("example users api")

Types

type DocumentsHandler

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

DocumentsHandler is an api handler that implements all Documents API endpoints functionality.

func NewDocuments

func NewDocuments(log *zap.Logger, mon *monkit.Scope, service DocumentsService, router *mux.Router, auth api.Auth) *DocumentsHandler

type DocumentsService

type DocumentsService interface {
	Get(ctx context.Context) ([]struct {
		ID             uuid.UUID      "json:\"id\""
		Path           string         "json:\"path\""
		Date           time.Time      "json:\"date\""
		Metadata       myapi.Metadata "json:\"metadata\""
		LastRetrievals []struct {
			User string    "json:\"user\""
			When time.Time "json:\"when\""
		} "json:\"last_retrievals\""
	}, api.HTTPError)
	GetOne(ctx context.Context, path string) (*myapi.Document, api.HTTPError)
	GetTag(ctx context.Context, path, tagName string) (*[2]string, api.HTTPError)
	GetVersions(ctx context.Context, path string) ([]myapi.Version, api.HTTPError)
	UpdateContent(ctx context.Context, path string, id uuid.UUID, date time.Time, request struct {
		Content string "json:\"content\""
	}) (*struct {
		ID        uuid.UUID "json:\"id\""
		Date      time.Time "json:\"date\""
		PathParam string    "json:\"pathParam\""
		Body      string    "json:\"body\""
	}, api.HTTPError)
}

type UsersHandler

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

UsersHandler is an api handler that implements all Users API endpoints functionality.

func NewUsers

func NewUsers(log *zap.Logger, mon *monkit.Scope, service UsersService, router *mux.Router, auth api.Auth) *UsersHandler

type UsersService

type UsersService interface {
	Get(ctx context.Context) ([]struct {
		Name    string "json:\"name\""
		Surname string "json:\"surname\""
		Email   string "json:\"email\""
	}, api.HTTPError)
	Create(ctx context.Context, request []struct {
		Name    string "json:\"name\""
		Surname string "json:\"surname\""
		Email   string "json:\"email\""
	}) api.HTTPError
}