132 lines
3.4 KiB
Go
132 lines
3.4 KiB
Go
package api
|
|
|
|
import (
|
|
"github.com/gin-gonic/gin"
|
|
"gitlab.guxuan.icu/jinshan_community/internal/mods/common/biz"
|
|
"gitlab.guxuan.icu/jinshan_community/internal/mods/common/schema"
|
|
"gitlab.guxuan.icu/jinshan_community/pkg/util"
|
|
)
|
|
|
|
// Defining the `Help` api.
|
|
type Help struct {
|
|
HelpBIZ *biz.Help
|
|
}
|
|
|
|
// @Tags HelpAPI
|
|
// @Security ApiKeyAuth
|
|
// @Summary Query help list
|
|
// @Param current query int true "pagination index" default(1)
|
|
// @Param pageSize query int true "pagination size" default(10)
|
|
// @Success 200 {object} util.ResponseResult{data=[]schema.Help}
|
|
// @Failure 401 {object} util.ResponseResult
|
|
// @Failure 500 {object} util.ResponseResult
|
|
// @Router /api/v1/helps [get]
|
|
func (a *Help) Query(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
var params schema.HelpQueryParam
|
|
if err := util.ParseQuery(c, ¶ms); err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
|
|
result, err := a.HelpBIZ.Query(ctx, params)
|
|
if err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
util.ResPage(c, result.Data, result.PageResult)
|
|
}
|
|
|
|
// @Tags HelpAPI
|
|
// @Security ApiKeyAuth
|
|
// @Summary Get help record by ID
|
|
// @Param id path string true "unique id"
|
|
// @Success 200 {object} util.ResponseResult{data=schema.Help}
|
|
// @Failure 401 {object} util.ResponseResult
|
|
// @Failure 500 {object} util.ResponseResult
|
|
// @Router /api/v1/helps/{id} [get]
|
|
func (a *Help) Get(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
item, err := a.HelpBIZ.Get(ctx, c.Param("id"))
|
|
if err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
util.ResSuccess(c, item)
|
|
}
|
|
|
|
// @Tags HelpAPI
|
|
// @Security ApiKeyAuth
|
|
// @Summary Create help record
|
|
// @Param body body schema.HelpForm true "Request body"
|
|
// @Success 200 {object} util.ResponseResult{data=schema.Help}
|
|
// @Failure 400 {object} util.ResponseResult
|
|
// @Failure 401 {object} util.ResponseResult
|
|
// @Failure 500 {object} util.ResponseResult
|
|
// @Router /api/v1/helps [post]
|
|
func (a *Help) Create(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
item := new(schema.HelpForm)
|
|
if err := util.ParseJSON(c, item); err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
} else if err := item.Validate(); err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
|
|
result, err := a.HelpBIZ.Create(ctx, item)
|
|
if err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
util.ResSuccess(c, result)
|
|
}
|
|
|
|
// @Tags HelpAPI
|
|
// @Security ApiKeyAuth
|
|
// @Summary Update help record by ID
|
|
// @Param id path string true "unique id"
|
|
// @Param body body schema.HelpForm true "Request body"
|
|
// @Success 200 {object} util.ResponseResult
|
|
// @Failure 400 {object} util.ResponseResult
|
|
// @Failure 401 {object} util.ResponseResult
|
|
// @Failure 500 {object} util.ResponseResult
|
|
// @Router /api/v1/helps/{id} [put]
|
|
func (a *Help) Update(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
item := new(schema.HelpForm)
|
|
if err := util.ParseJSON(c, item); err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
} else if err := item.Validate(); err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
|
|
err := a.HelpBIZ.Update(ctx, c.Param("id"), item)
|
|
if err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
util.ResOK(c)
|
|
}
|
|
|
|
// @Tags HelpAPI
|
|
// @Security ApiKeyAuth
|
|
// @Summary Delete help record by ID
|
|
// @Param id path string true "unique id"
|
|
// @Success 200 {object} util.ResponseResult
|
|
// @Failure 401 {object} util.ResponseResult
|
|
// @Failure 500 {object} util.ResponseResult
|
|
// @Router /api/v1/helps/{id} [delete]
|
|
func (a *Help) Delete(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
err := a.HelpBIZ.Delete(ctx, c.Param("id"))
|
|
if err != nil {
|
|
util.ResError(c, err)
|
|
return
|
|
}
|
|
util.ResOK(c)
|
|
}
|