Documentation
¶
Overview ¶
Package api ... generated version: 1.6.1
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IPutUserController ¶
type IPutUserController interface {
PutUser(c echo.Context, req *PutUserRequest) (res *PutUserResponse, err error)
}
IPutUserController ...
type PutUserController ¶
type PutUserController struct {
*props.ControllerProps
}
PutUserController ...
func NewPutUserController ¶
func NewPutUserController(cp *props.ControllerProps) *PutUserController
NewPutUserController ...
func (*PutUserController) PutUser ¶
func (p *PutUserController) PutUser( c echo.Context, req *PutUserRequest, ) (res *PutUserResponse, err error)
PutUser user creation api controller @Summary CreateUserAPI @Description user creation api @Accept json @Produce json @Param name body string true "user name" @Param age body integer true "user age" @Param gender body model.Gender true "user gender" @Success 200 {object} PutUserResponse @Failure 400 {object} wrapper.APIError @Failure 500 {object} wrapper.APIError @Router /api/user [PUT]
type PutUserRequest ¶
type PutUserRequest struct {
Name string `json:"name" validate:"required,min=3,max=10,excludesall=!()#@{}"`
Age int `json:"age" validate:"required,gt=0,lte=150"`
Gender model.Gender `json:"gender" validate:"required,oneof=1 2 3"`
}
PutUserRequest - user creation request
type PutUserResponse ¶
type PutUserResponse struct {
Status int `json:"status"`
User *model.User `json:"payload,omitempty"`
}
PutUserResponse - user creation response
Click to show internal directories.
Click to hide internal directories.