server

func BaseAPIHandler ¶ added in v0.0.9

func BaseAPIHandler(c *gin.Context)

BaseAPIHandler handles the base API route.

func BaseUIHandler ¶

func BaseUIHandler(c *gin.Context)

BaseUIHandler handles the base UI route.

func CategoryHandler ¶ added in v0.0.9

func CategoryHandler(c *gin.Context)

CategoryHandler godoc.

@Summary		Fetch categories
@Description	get categories with optional filters

@Tags			api
@Accept			json
@Produce		json

@Param			random	query		bool	false	"If exists or true, returns `limit` random records."
@Param			id		query		int64	false	"If exists, returns the record with the given id."
@Param			limit	query		int64	false	"Limit the number of records returned."	Default(10)

@Success		200		{array}		models.Category
@Failure		500		{object}	utils.HTTPError
@Router			/category [get]

func ClueHandler ¶ added in v0.0.9

func ClueHandler(c *gin.Context)

ClueHandler godoc

@Summary		Fetch Clues
@Description	get clues with optional filters

@Tags			api
@Accept			json
@Produce		json

@Param			random		query		bool	false	"If exists or true, returns `limit` random records."
@Param			id			query		int64	false	"If exists, returns the record with the given id."
@Param			game		query		integer	false	"Filter by Game ID"
@Param			category	query		integer	false	"Filter by Category ID"
@Param			limit		query		int64	false	"Limit the number of records returned"	Default(10)

@Success		200			{array}		models.Clue
@Failure		500			{object}	utils.HTTPError
@Router			/clue [get]

func GameHandler ¶ added in v0.0.9

func GameHandler(c *gin.Context)

GameHandler godoc

@Summary		Fetch Games
@Description	get games with optional filters

@Tags			api
@Accept			json
@Produce		json

@Param			random	query		bool	false	"If exists or true, returns `limit` random records."
@Param			id		query		int64	false	"If exists, returns the record with the given id."
@Param			limit	query		int64	false	"Limit the number of records returned."	Default(10)

@Success		200		{array}		models.Game
@Failure		500		{object}	utils.HTTPError
@Router			/game [get]