server

Documentation

Index

• func BaseAPIHandler(c *gin.Context)
• func BaseUIHandler(c *gin.Context)
• func CategoryHandler(c *gin.Context)
• func ClueHandler(c *gin.Context)
• func DebugUIHandler(c *gin.Context)
• func GameHandler(c *gin.Context)
• type ClueFilter
• type Filter
• type Server
  • func NewServer() *Server
• type StringResponse

Functions

func BaseAPIHandler

func BaseAPIHandler(c *gin.Context)

BaseHandler godoc

@Summary		Base api handler
@Description	List available endpoints

@Tags			root
@Accept			*/*
@Produce		json
@Success		200	{array}	string	"list of available endpoints"
@Router			/ [get]

func BaseUIHandler

func BaseUIHandler(c *gin.Context)

BaseUIHandler handles the base UI route.

func CategoryHandler

func CategoryHandler(c *gin.Context)

CategoryHandler godoc.

@Summary		Returns a list of categories.
@Description	Returns a list of categories.
@Tags			api
@Accept			json
@Produce		json
@Param			random	query	bool	false	"If exists, returns up to `limit` random records."
@Param			id		query	int64	false	"If exists, returns the record with the given id."
@Param			page	query	int64	false	"Paging offset"
@Param			limit	query	int64	false	"Limit the number of records returned"
@Success		200		{array}	models.Category
@Router			/category [get]

func ClueHandler

func ClueHandler(c *gin.Context)

ClueHandler godoc

@Summary		Returns a list of clues
@Description	Returns a list of clues

@Tags			api
@Accept			*/*
@Produce		json
@Param			random		query		bool	false	"Random Clue"
@Param			id			query		integer	false	"Clue ID"
@Param			game		query		integer	false	"Game ID"
@Param			category	query		integer	false	"Category ID"
@Success		200			{array}		models.Clue
@Failure		400			{object}	utils.HTTPError
@Failure		500			{object}	utils.HTTPError
@Router			/clue [get]

func DebugUIHandler

func DebugUIHandler(c *gin.Context)

func GameHandler

func GameHandler(c *gin.Context)

GameHandler godoc

@Summary		Returns a list of games
@Description	Returns a list of games

@Tags			api
@Accept			*/*
@Produce		json
@Param			filter	query		Filter	false	"Filter games"
@Success		200		{array}		models.Game
@Failure		500		{object}	utils.HTTPError
@Router			/game [get]

Types

type ClueFilter

type ClueFilter struct {
	Filter
	GameID     int64 `form:"game"`
	CategoryID int64 `form:"category"`
}

type Filter

type Filter struct {
	Random *bool  `form:"random"`
	ID     *int64 `form:"id"`
	Page   *int64 `form:"page,default=0" binding:"min=0"`
	Limit  *int64 `form:"limit,default=1" binding:"min=1,max=100"`
}

type Server

type Server struct {
	ID     string
	Clock  clock.Clock
	Router *gin.Engine
	JDB    *sqlx.DB
}

Server is the API server.

func NewServer

func NewServer() *Server

NewServer returns a new API server.

type StringResponse

type StringResponse struct {
	Message string `json:"message" example:"some string value"`
}