Documentation
¶
Index ¶
- func AddFilm(c *gin.Context)
- func ApiOverview(c *gin.Context)
- func ClearCookie(c *gin.Context)
- func DeleteFilm(c *gin.Context)
- func FetchAllFilms(c *gin.Context)
- func FetchFilmsFilter(c *gin.Context)
- func FetchPage(c *gin.Context)
- func FetchSingleFilm(c *gin.Context)
- func InsertTokensToCookie(c *gin.Context, accessToken, refreshToken string, ...)
- func RespondWithError(c *gin.Context, code int, message interface{})
- func RespondWithSuccess(c *gin.Context, code int, message interface{})
- func SignIn(c *gin.Context)
- func SignOut(c *gin.Context)
- func SignUp(c *gin.Context)
- func UpdateFilm(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddFilm ¶
AddFilm godoc @Summary Add film by json body @Description Add film json body @Tags api @Accept json @Produce json @Param Film body tmdb.Film true "Added the film by fields" @Description "Only with user role = 'admin'" @Success 200 "{"ok": "film successful added with that ID ___"}" @Failure 400 "{"error": "film is exist with that ___"}" string @Security ApiKeyAuth Token @Security ApiKeyAuth Refresh @Router /api/v1/films/ [post]
func ApiOverview ¶
ApiOverview godoc @Summary Api overview @Description Api overview @Tags api @Accept json @Produce json @Success 200 {object} database.Overview "Return films and user count" @Failure 400 "{"error": "can't fetch from db films"}" string @Security ApiKeyAuth Token @Security ApiKeyAuth Refresh @Router /api/v1/ [get]
func ClearCookie ¶
func DeleteFilm ¶
DeleteFilm godoc @Summary Delete film by ID @Description Delete film by ID @Tags api @Accept json @Produce json @Param ID path int true "Delete film by ID" @Success 200 "{"ok": "film with ID ___ deleted"}" @Failure 400 "{"error": "film ID doesn't exist in database: ___"}" string @Description "Only with user role = 'admin'" @Security ApiKeyAuth Token @Security ApiKeyAuth Refresh @Router /api/v1/films/film/{ID} [delete]
func FetchAllFilms ¶
FetchAllFilms godoc @Summary Get all films @Description Get all films @Tags api @Accept json @Produce json @Success 200 {array} tmdb.Film "Return all films" @Failure 400 "{"error": "can't fetch from db films"}" string @Security ApiKeyAuth Token @Security ApiKeyAuth Refresh @Router /api/v1/films/ [get]
func FetchFilmsFilter ¶
FetchFilmsFilter godoc @Summary Filter films @Description Filter films by name or/and genre, year, page @Tags api @Accept json @Produce json @Param name query string false "Film name" @Param year query string false "Film year production" @Param genre query string false "Film genre" @Param page query string false "Film page of the results" @Success 200 {array} tmdb.Film "Return slice of films with filter" @Failure 400 "{"error": "no films matches"}" @Security ApiKeyAuth Token, Refresh @Router /api/v1/films/filter [get]
func FetchPage ¶
FetchPage godoc @Summary Fetch by page films @Description Filter films page @Tags api @Accept json @Produce json @Param ID path string true "Film page of the results" @Success 200 {array} tmdb.Film "Return slice of films with filter" @Failure 400 "{"error": "no films matches"/"bad page request"/ "invalid page number"}" @Security ApiKeyAuth Token, Refresh @securityDefinitions.ApiKeyAuth[Refresh,Token] @Router /api/v1/films/page/{ID} [get]
func FetchSingleFilm ¶
FetchSingleFilm godoc @Summary Get single film by ID @Description Get single film by ID @Tags api @Accept json @Produce json @Param ID path int true "Get single film by ID" @Success 200 {object} tmdb.Film "Return single film by ID" @Failure 400 "{"error": "film ID doesn't exist in database: ____"}" string @Security ApiKeyAuth Token @Security ApiKeyAuth Refresh @Router /api/v1/films/film/{ID} [get]
func InsertTokensToCookie ¶
func RespondWithError ¶
func RespondWithSuccess ¶
func SignIn ¶
SignIn godoc @Summary Sign In @Description Sign In into server, add cookies @Tags users @Accept json @Produce json @Param Login body database.User false "Add login and password" @Success 200 "{"success":"Sign In"}" @Header 200 {string} Token "JWT Token" @Header 200 {string} Refresh "JWT refresh Token" @Failure 406 "{"error":"this user isn't in the database."}" @Router /users/auth/signin/ [post]
func SignOut ¶
SignOut godoc @Summary Sign Out @Description Sign Out from server, delete cookies @Tags users @Accept json @Produce json @Success 200 "{"success":"Sign Out"}" @Failure 406 "{"error":"http: named cookie not present"/"wrong refresh token"}" @Router /users/auth/signout/ [get]
func SignUp ¶
SignUp godoc @Summary Sign Up @Description Sign Up into server, add cookies @Tags users @Accept json @Produce json @Param Login body database.User false "Add login and password" @Header 200 {string} Token "JWT Token" @Header 200 {string} Refresh "JWT refresh Token" @Success 200 "{"success":"Sign Up"}" @Failure 406 "{"error":"this user is already exist in database."}" @Router /users/auth/signup/ [post]
func UpdateFilm ¶
UpdateFilm godoc @Summary Update film by json body @Description Update film by ID @Tags api @Accept json @Produce json @Param Film body tmdb.Film true "Update the film by fields" @Description "Only with user role = 'admin'" @Success 200 "{"ok": "film successful updated with that ID ___"}" @Failure 400 "{"error": "film isn't exist with that ID ___"}" string @Security ApiKeyAuth Token @Security ApiKeyAuth Refresh @Router /api/v1/films/ [put]
Types ¶
This section is empty.