example

Documentation

Index

• Variables
• type DocumentsHandler
  • func NewDocuments(log *zap.Logger, mon *monkit.Scope, service DocumentsService, ...) *DocumentsHandler
• type DocumentsService
• type Project
• type ProjectsHandler
  • func NewProjects(log *zap.Logger, mon *monkit.Scope, service ProjectsService, ...) *ProjectsHandler
• type ProjectsService
• 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 ErrProjectsAPI = errs.Class("example projects 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) ([]myapi.Document, 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 myapi.NewDocument) (*myapi.Document, api.HTTPError)
}

type Project

type Project struct {
	ID        uuid.UUID `json:"id"`
	OwnerName string    `json:"ownerName"`
}

Project contains project information.

type ProjectsHandler

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

ProjectsHandler is an api handler that implements all Projects API endpoints functionality.

func NewProjects

func NewProjects(log *zap.Logger, mon *monkit.Scope, service ProjectsService, router *mux.Router) *ProjectsHandler

type ProjectsService

type ProjectsService interface {
	CreateProject(ctx context.Context, request Project) (*Project, 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) *UsersHandler

type UsersService

type UsersService interface {
	Get(ctx context.Context) ([]myapi.User, api.HTTPError)
	Create(ctx context.Context, request []myapi.User) api.HTTPError
	GetAge(ctx context.Context) (*myapi.UserAge[int16], api.HTTPError)
}