api

Documentation

Index

• Variables
• type API
  • func New(auth Auth, tests Tests, passage Passage) *API
  • func (a *API) NoRoute(c *gin.Context)
  • func (a *API) Ping(c *gin.Context)
  • func (a *API) RegisterRoutes(router *gin.Engine)
• type Auth
• type ErrorDefault
• type Passage
• type Tests

Variables

var ErrNoRoute = errors.New("this route not allowed")

Types

type API

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

func New

func New(auth Auth, tests Tests, passage Passage) *API

func (*API) NoRoute

func (a *API) NoRoute(c *gin.Context)

func (*API) Ping

func (a *API) Ping(c *gin.Context)

func (*API) RegisterRoutes

func (a *API) RegisterRoutes(router *gin.Engine)

type Auth

type Auth interface {
	Registration(c *gin.Context)
	Authentication(c *gin.Context)
	Refresh(c *gin.Context)
	Identification(c *gin.Context)
	PasswordSaltByEmail(c *gin.Context)
}

type ErrorDefault

type ErrorDefault struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Passage

type Passage interface {
	Create(c *gin.Context)
	Read(c *gin.Context)
	Update(c *gin.Context)
	End(c *gin.Context)
}

type Tests

type Tests interface {
	Search(c *gin.Context)
	Landing(c *gin.Context)
}