Documentation
¶
Index ¶
- type ApplicationController
- type AuthController
- type GraphQLController
- type HelloController
- type Services
- type UserController
- func (c *UserController) CreateUserHandler(context *gin.Context)
- func (c *UserController) DeleteUserHandler(context *gin.Context)
- func (c *UserController) GetUserByIdHandler(context *gin.Context)
- func (c *UserController) GetUsersHandler(context *gin.Context)
- func (c *UserController) UpdateUserHandler(context *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationController ¶
type ApplicationController struct {
// contains filtered or unexported fields
}
func NewApplicationController ¶
func NewApplicationController(appName string) *ApplicationController
func (*ApplicationController) ApplicationInformationHandler ¶
func (c *ApplicationController) ApplicationInformationHandler(context *gin.Context)
ApplicationInformationHandler godoc
@Summary Retrieve application information
@Schemes
@Description Retrieve application information
@Tags Application
@Accept json
@Produce json
@Success 200 {object} serializers.ApplicationSerializer
@Security bearerAuth
@Router / [get]
type AuthController ¶
type AuthController struct {
// contains filtered or unexported fields
}
func NewAuthController ¶
func NewAuthController( cryptoService services.CryptoService, jwtService services.JWTService, userService services.UserService, loggerService services.LoggerService, ) *AuthController
func (*AuthController) GetAccessTokenHandler ¶
func (c *AuthController) GetAccessTokenHandler(context *gin.Context)
GetAccessTokenHandler godoc
@Summary Get access token (login)
@Description Get token
@Tags Auth
@Accept json
@Produce json
@Param Accept-Language header string false "Language" default(en-US)
@Param User body dto.LoginDTO true "User data to be created"
@Success 200 {object} serializers.TokenSerializer "desc"
@Failure 401 {object} response.Response "desc"
@Failure 500 {object} response.Response "desc"
@Router /api/v1/auth/login [post]
type GraphQLController ¶
type GraphQLController struct {
// contains filtered or unexported fields
}
func NewGraphQLController ¶
func NewGraphQLController(schema graphql.Schema) *GraphQLController
func (*GraphQLController) GraphQLHandler ¶
func (c *GraphQLController) GraphQLHandler(ctx *gin.Context)
func (*GraphQLController) SandboxHandler ¶
func (c *GraphQLController) SandboxHandler(ctx *gin.Context)
type HelloController ¶
type HelloController struct{}
func NewHelloController ¶
func NewHelloController() *HelloController
func (*HelloController) HelloHandler ¶
func (c *HelloController) HelloHandler(context *gin.Context)
HelloHandler godoc
@Summary Say Hello
@Description Say Hello
@Tags Hello
@Accept json
@Produce json
@Param name path string true "Name" default(Joe)
@Param Accept-Language header string false "Language" default(en-US)
@Success 200 {object} serializers.HelloSerializer
@Router /api/v1/hello/{name} [get]
type Services ¶
type Services struct {
UserService services.UserService
CryptoService services.CryptoService
LoggerService services.LoggerService
}
type UserController ¶
type UserController struct {
// contains filtered or unexported fields
}
func NewUserController ¶
func NewUserController(services *Services) *UserController
func (*UserController) CreateUserHandler ¶
func (c *UserController) CreateUserHandler(context *gin.Context)
CreateUserHandler godoc
@Summary Create a new user
@Description Register a new user based on provided data
@Tags User
@Accept json
@Produce json
@Param Accept-Language header string false "Language" default(en-US)
@Param User body serializers.UserSerializer true "User data to be created"
@Success 201 {object} serializers.UserSerializer "desc"
@Failure 400 {object} response.Response "desc"
@Failure 500 {object} response.Response "desc"
@Router /api/v1/users [post]
func (*UserController) DeleteUserHandler ¶
func (c *UserController) DeleteUserHandler(context *gin.Context)
DeleteUserHandler godoc
@Summary Delete a user
@Description Remove a user based on provided ID
@Tags User
@Accept json
@Produce json
@Param id path int true "User ID" default(1)
@Param Accept-Language header string false "Language" default(en-US)
@Success 200 {object} response.Response "desc"
@Failure 500 {object} response.Response "desc"
@Router /api/v1/users/{id} [delete]
func (*UserController) GetUserByIdHandler ¶
func (c *UserController) GetUserByIdHandler(context *gin.Context)
GetUserByIdHandler godoc
@Summary Get user account by ID
@Description get string by ID
@Tags User
@Accept json
@Produce json
@Param id path int true "User ID" default(1)
@Param Accept-Language header string false "Language" default(en-US)
@Success 200 {object} response.Response{data=serializers.UserSerializer} "desc"
@Failure 404 {object} response.Response "desc"
@Router /api/v1/users/{id} [get]
func (*UserController) GetUsersHandler ¶
func (c *UserController) GetUsersHandler(context *gin.Context)
GetUsersHandler godoc
@Summary List all users
@Description Retrieves a list of all registered users
@Tags User
@Accept json
@Produce json
@Param Accept-Language header string false "Language" default(en-US)
@Success 200 {array} serializers.UserSerializer "desc"
@Failure 401 {object} response.Error "desc"
@Security bearerAuth
@Router /api/v1/users [get]
func (*UserController) UpdateUserHandler ¶
func (c *UserController) UpdateUserHandler(context *gin.Context)
UpdateUserHandler godoc
@Summary Update a user
@Description Modify an existing user based on provided data
@Tags User
@Accept json
@Produce json
@Param id path int true "User ID" default(1)
@Param User body serializers.UserSerializer true "User data to be updated"
@Param Accept-Language header string false "Language" default(en-US)
@Success 200 {object} serializers.UserSerializer "desc"
@Failure 400 {object} response.Response "desc"
@Failure 500 {object} response.Response "desc"
@Router /api/v1/users/{id} [put]
Source Files
Click to show internal directories.
Click to hide internal directories.