package
0.0.0-20220703144001-c35fd87a1b1a
Repository: https://github.com/tienanh129902/go-rest-api.git
Documentation: pkg.go.dev
# Functions
Delete question @Summary Delete question @tags Question @Accept json @Produce json @Param id path int true "Question ID" @Success 200 {object} datatransfers.Status "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 404 {object} datatransfers.Error "Not found" @Router /question/{id} [delete].
Create question @Summary List all questions @Security ApiKeyAuth @tags Play @Accept json @Produce json @Success 200 {object} datatransfers.Data "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /play [get].
GetCurrentUser godoc @Summary Show current user @Accept json @tags User @Produce json @Security ApiKeyAuth @Success 200 {object} datatransfers.UserInfo "ok" @Failure 404 {object} datatransfers.Error "Not found" @Router /user/me [get].
Get question by ID @Summary Get question by ID @Security ApiKeyAuth @tags Question @Accept json @Produce json @Param id path int true "Question ID" @Success 200 {object} datatransfers.Data "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 404 {object} datatransfers.Error "Not found" @Router /question/{id} [get].
Get score board by user id @Summary Get score board by user ID @tags Scoreboard @Accept json @Produce json @Security ApiKeyAuth @Param userid path int true "User ID" @Success 200 {object} datatransfers.Data "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /score/{userid} [get].
GetUserById godoc @Summary Show user info @tags User @Accept json @Produce json @Security ApiKeyAuth @Param id path int true "User ID" @Success 200 {object} datatransfers.UserInfo "ok" @Failure 400 {object} datatransfers.Error "We need ID!!" @Failure 404 {object} datatransfers.Error "Can not find user" @Router /user/{id} [get].
UpdateUserData @tags User @Summary Update user data @Accept json @Produce json @Security ApiKeyAuth @Param id path int true "User ID" @Success 200 {object} datatransfers.UserInfo "ok" @Failure 400 {object} datatransfers.Error "We need ID!!" @Failure 404 {object} datatransfers.Error "Can not find user" @Router /user/ [patch].
Create question @Summary Create question @tags Question @Security ApiKeyAuth @Accept json @Produce json @Param question body datatransfers.QuestionCreate true "Question data" @Success 200 {object} datatransfers.Status "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /question [post].
Login @Summary Login user @tags Authentication @Accept json @Produce json @Param user body datatransfers.UserLogin true "User info" @Success 200 {object} datatransfers.Token "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /auth/login [post].
Logout @Summary Logout user @tags Authentication @Accept json @Produce json @Security ApiKeyAuth @Param user body datatransfers.UserLogout true "Refresh token" @Success 200 {object} datatransfers.Status "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /auth/logout [post].
Register @Summary user registration @tags Authentication @Accept json @Produce json @Param user body datatransfers.UserSignup true "User info" @Success 200 {object} datatransfers.Status "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /auth/signup [post].
Submit survey @Summary Submit survey @tags Play @Accept json @Produce json @Security ApiKeyAuth @Param answerArray body datatransfers.AnswerSubmitArray true "List of answer per question" @Success 201 {object} datatransfers.Data "Ok" @Failure 400 {object} datatransfers.Error "Bad request" @Failure 401 {object} datatransfers.Error "Unauthorized" @Router /play/submit [post].