swagger

func (*Handler) GetApiDocJson ¶

func (h *Handler) GetApiDocJson(ctx *gin.Context)

GetApiDocJson godoc

@Id				Swagger API specification in JSON
@Summary		Swagger JSON
@Description	Request for getting swagger specification in JSON
@Tags			Swagger API
@Produce		application/yaml
@Success		200	{object}	string
@Router			/swagger/api-docs.json [get]

func (*Handler) GetApiDocYaml ¶

func (h *Handler) GetApiDocYaml(ctx *gin.Context)

GetApiDocYaml godoc

@Id				Swagger API specification in YAML
@Summary		Swagger YAML
@Description	Request for getting swagger specification in YAML
@Tags			Swagger API
@Produce		application/yaml
@Success		200	{object}	string
@Router			/swagger/api-docs.yaml [get]

func (*Handler) GetUI ¶

func (h *Handler) GetUI(ctx *gin.Context)

GetUI godoc

@Id				SwaggerUI
@Summary		Swagger UI
@Description	Request for getting swagger UI
@Tags			Swagger API
@Produce		text/html
@Success		200	{object}	string
@Router			/swagger/index.html [get]

func (*Handler) RegisterRoutes ¶

func (h *Handler) RegisterRoutes(router *gin.Engine, _ handler.RouteMiddlewares)