trace-system/backend-go
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: integrate swagger documentation and gin cors middleware

Browse Source
This commit is contained in:
郑肖毅
2026-02-12 19:13:58 +08:00
parent aed996f409
commit d51e2dc500
13 changed files with 3378 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
controllers/auth_controller.go
View File

@@ -28,9 +28,9 @@ func NewAuthController() *AuthController {
// @Accept json
// @Produce json
// @Param loginData body models.LoginDTO true "登录数据"
// @Success 200 {object} gin.H{message: string, accessToken: string, user: models.UserDTO}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Success 200 {object} models.LoginResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Router /auth/login [post]
func (c *AuthController) Login(ctx *gin.Context) {
var loginData models.LoginDTO
@@ -78,8 +78,8 @@ func (c *AuthController) Login(ctx *gin.Context) {
// @Tags 认证
// @Produce json
// @Security BearerAuth
// @Success 200 {object} models.UserDTO
// @Failure 401 {object} gin.H{message: string}
// @Success 200 {object} models.DataResponse
// @Failure 401 {object} models.ErrorResponse
// @Router /auth/profile [get]
func (c *AuthController) GetProfile(ctx *gin.Context) {
userModel, ok := GetCurrentUser(ctx)
@@ -106,9 +106,9 @@ func (c *AuthController) GetProfile(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param passwordData body models.ChangePasswordDTO true "密码修改数据"
// @Success 200 {object} gin.H{message: string}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Success 200 {object} models.BaseResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Router /auth/change-password [post]
func (c *AuthController) ChangePassword(ctx *gin.Context) {
userModel, ok := GetCurrentUser(ctx)
@@ -138,9 +138,9 @@ func (c *AuthController) ChangePassword(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param profileData body models.UpdateProfileDTO true "用户信息更新数据"
// @Success 200 {object} models.UserDTO
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Success 200 {object} models.DataResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Router /auth/profile [put]
func (c *AuthController) UpdateProfile(ctx *gin.Context) {
userModel, ok := GetCurrentUser(ctx)

42
controllers/companies_controller.go
View File

@@ -30,9 +30,9 @@ func NewCompaniesController() *CompaniesController {
// @Param page query int false "页码"
// @Param limit query int false "每页数量"
// @Param search query string false "搜索关键词"
// @Success 200 {object} gin.H{message: string, data: []models.Company, pagination: gin.H{page: int, limit: int, total: int, totalPages: int}}
// @Failure 401 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.PaginationResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /companies [get]
func (c *CompaniesController) FindAll(ctx *gin.Context) {
page, _ := strconv.Atoi(ctx.DefaultQuery("page", "1"))
@@ -66,12 +66,12 @@ func (c *CompaniesController) FindAll(ctx *gin.Context) {
// @Accept json
// @Produce json
// @Security BearerAuth
// @Param companyData body gin.H{companyName: string} true "企业数据"
// @Success 201 {object} gin.H{message: string, company: models.Company}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 409 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Param companyData body models.CompanyDataRequest true "企业数据"
// @Success 201 {object} models.CompanyResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 409 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /companies [post]
func (c *CompaniesController) Create(ctx *gin.Context) {
var companyData struct {
@@ -113,13 +113,13 @@ func (c *CompaniesController) Create(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param companyName path string true "企业名称"
// @Param companyData body gin.H{companyName?: string, isActive?: bool} true "企业数据"
// @Success 200 {object} gin.H{message: string, company: models.Company}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 404 {object} gin.H{message: string}
// @Failure 409 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Param companyData body models.CompanyUpdateRequest true "企业数据"
// @Success 200 {object} models.CompanyResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 404 {object} models.ErrorResponse
// @Failure 409 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /companies/{companyName} [put]
func (c *CompaniesController) Update(ctx *gin.Context) {
companyName := ctx.Param("companyName")
@@ -167,11 +167,11 @@ func (c *CompaniesController) Update(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param companyName path string true "企业名称"
// @Success 200 {object} gin.H{message: string}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 404 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.BaseResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 404 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /companies/{companyName} [delete]
func (c *CompaniesController) Delete(ctx *gin.Context) {
companyName := ctx.Param("companyName")

62
controllers/serials_controller.go
View File

@@ -30,10 +30,10 @@ func NewSerialsController() *SerialsController {
// @Produce json
// @Security BearerAuth
// @Param generateData body models.GenerateSerialDTO true "生成数据"
// @Success 200 {object} gin.H{message: string, serials: []models.Serial}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.DataResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials/generate [post]
func (c *SerialsController) Generate(ctx *gin.Context) {
userModel, ok := GetCurrentUser(ctx)
@@ -70,10 +70,10 @@ func (c *SerialsController) Generate(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param generateData body models.GenerateWithPrefixDTO true "生成数据"
// @Success 200 {object} gin.H{message: string, serials: []models.Serial}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.DataResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials/generate-with-prefix [post]
func (c *SerialsController) GenerateWithPrefix(ctx *gin.Context) {
userModel, ok := GetCurrentUser(ctx)
@@ -112,11 +112,11 @@ func (c *SerialsController) GenerateWithPrefix(ctx *gin.Context) {
// @Security BearerAuth
// @Param serialNumber path string true "序列号"
// @Param qrCodeData body models.QRCodeDTO false "二维码数据"
// @Success 200 {object} gin.H{message: string, qrCodeData: string, queryUrl: string}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 404 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.QRCodeResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 404 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials/{serialNumber}/qrcode [post]
func (c *SerialsController) GenerateQRCode(ctx *gin.Context) {
serialNumber := ctx.Param("serialNumber")
@@ -154,10 +154,10 @@ func (c *SerialsController) GenerateQRCode(ctx *gin.Context) {
// @Tags 序列号查询
// @Produce json
// @Param serialNumber path string true "序列号"
// @Success 200 {object} gin.H{message: string, serial: models.Serial}
// @Failure 400 {object} gin.H{message: string}
// @Failure 404 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.DataResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 404 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials/{serialNumber}/query [get]
func (c *SerialsController) Query(ctx *gin.Context) {
serialNumber := ctx.Param("serialNumber")
@@ -180,11 +180,11 @@ func (c *SerialsController) Query(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param page query int false "页码"
// @Param limit query int false "每页数量"
// @Param limit query int false " "每页数量"
// @Param search query string false "搜索关键词"
// @Success 200 {object} gin.H{message: string, data: []models.Serial, pagination: gin.H{page: int, limit: int, total: int, totalPages: int}}
// @Failure 401 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.PaginationResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials [get]
func (c *SerialsController) FindAll(ctx *gin.Context) {
page, _ := strconv.Atoi(ctx.DefaultQuery("page", "1"))
@@ -217,11 +217,11 @@ func (c *SerialsController) FindAll(ctx *gin.Context) {
// @Security BearerAuth
// @Param serialNumber path string true "序列号"
// @Param updateData body models.UpdateSerialDTO true "更新数据"
// @Success 200 {object} gin.H{message: string, serial: models.Serial}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 404 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.DataResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 404 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials/{serialNumber} [put]
func (c *SerialsController) Update(ctx *gin.Context) {
serialNumber := ctx.Param("serialNumber")
@@ -249,11 +249,11 @@ func (c *SerialsController) Update(ctx *gin.Context) {
// @Produce json
// @Security BearerAuth
// @Param serialNumber path string true "序列号"
// @Success 200 {object} gin.H{message: string}
// @Failure 400 {object} gin.H{message: string}
// @Failure 401 {object} gin.H{message: string}
// @Failure 404 {object} gin.H{message: string}
// @Failure 500 {object} gin.H{message: string}
// @Success 200 {object} models.BaseResponse
// @Failure 400 {object} models.ErrorResponse
// @Failure 401 {object} models.ErrorResponse
// @Failure 404 {object} models.ErrorResponse
// @Failure 500 {object} models.ErrorResponse
// @Router /serials/{serialNumber}/revoke [post]
func (c *SerialsController) Revoke(ctx *gin.Context) {
serialNumber := ctx.Param("serialNumber")