tsk-15: Add API documentation (#17)
Closes #15 Reviewed-on: phoenix/textsender-auth#17 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>
This commit is contained in:
@@ -29,6 +29,18 @@ func NewLoginHandler(userStore model.UserStore) *LoginHandler {
|
||||
return &LoginHandler{UserStore: userStore}
|
||||
}
|
||||
|
||||
// Login godoc
|
||||
// @Summary Login
|
||||
// @Description Login and be given an access token (requires JWT)
|
||||
// @Tags users
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security BearerAuth
|
||||
// @Param request body LoginAccount true "Data to obtain a token"
|
||||
// @Success 200 {object} LoginResponse
|
||||
// @Failure 400 {object} LoginResponse
|
||||
// @Failure 500 {object} LoginResponse
|
||||
// @Router /login [post]
|
||||
func (l *LoginHandler) Login(w http.ResponseWriter, r *http.Request) {
|
||||
var req LoginAccount
|
||||
if err := ExtractFromRequest(r, &req); err != nil {
|
||||
|
||||
@@ -36,6 +36,18 @@ func NewUserHandler(userStore model.UserStore) *UserHandler {
|
||||
return &UserHandler{UserStore: userStore}
|
||||
}
|
||||
|
||||
// Register godoc
|
||||
// @Summary Register user
|
||||
// @Description Create a user that can send texts (requires JWT)
|
||||
// @Tags users
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security BearerAuth
|
||||
// @Param request body RegisterUser true "Data to add user"
|
||||
// @Success 200 {object} RegisterResponse
|
||||
// @Failure 400 {object} RegisterResponse
|
||||
// @Failure 500 {object} RegisterResponse
|
||||
// @Router /register [post]
|
||||
func (u *UserHandler) Register(w http.ResponseWriter, r *http.Request) {
|
||||
var req RegisterUser
|
||||
err := ExtractFromRequest(r, &req)
|
||||
|
||||
Reference in New Issue
Block a user