package
0.1.0-alpha
Repository: https://github.com/trickingapi/trickingapi.git
Documentation: pkg.go.dev

# Functions

GetAllCategories godoc @Description Reads and returns all existing categories of tricks from the tricks.json file at https://github.com/TrickingApi/trickingapi @Sumary Get All Category Names from TrickingApi/data/tricks @Tags categories @Accept */* @Produce json @Success 200 {object} []string @Router /categories [get].
GetAllTrickNames godoc @Description Returns the names of all tricks from the static trickNames.json file at https://github.com/TrickingApi/trickingapi @Summary Get All Trick Names and their ids from TrickingApi/data/tricks @Tags tricks @Accept */* @Produce json @Success 200 {object} map[string]string @Router /tricks/names [get].
GetAllTricksByCategories godoc @Description Reads and returns a mapping of categories to list of tricks from the tricks.json file at https://github.com/TrickingApi/trickingapi @Summary Get All Tricks Grouped by Categories from TrickingApi/data/tricks @Tags categories, tricks @Accept */* @Produce json @Success 200 {object} map[models.TrickCategory][]models.Trick @Router /categories/tricks [get].
GetAllTricks godoc @Description Reads and returns list of tricks from the static tricks.json file at https://github.com/TrickingApi/trickingapi @Summary Get All Tricks from TrickingApi/data/tricks @Tags tricks @Accept */* @Produce json @Success 200 {object} map[string]models.Trick @Router /tricks [get].
GetTrick godoc @Description reads list of known Trick objects and returns trick matching the name param in the request @Summary Get Trick by Specific Name from TrickingApi/data/tricks @Tags tricks @Accept */* @Produce json @Success 200 {object} models.Trick @Failure 404 {object} models.TrickError @Router /tricks:name [get].
GetTricksForCategory godoc @Description Reads and returns a list of tricks for a specific category from the tricks.json file at https://github.com/TrickingApi/trickingapi @Summary Get All Tricks Grouped Under A Category from TrickingApi/data/tricks @Tags categories, tricks @Accept */* @Produce json @Success 200 {object} []models.Trick @Router /categories/:name [get].
No description provided by the author