Swagger UI 仍然显示示例

Question

我想将 Swagger 用于 Go 和 Gin 的 RESTFul API 文档。

我在 main.go 中有这段代码： package main

import (
    "gowebservice/config"
    "gowebservice/controllers"

    "github.com/gin-gonic/gin"
    swaggerFiles "github.com/swaggo/files"
    ginSwagger "github.com/swaggo/gin-swagger"

    _ "github.com/swaggo/gin-swagger/example/basic/docs"
)

// @title Students API
// @version 1.0
// @description This is a basic API Students using Gin and Gorm.

// @host localhost:8080
// @BasePath /

func main() {
    r := gin.Default()

    config.ConnectDatabase()

    v1 := r.Group("/api/v1")
    {
        v1.GET("students/all", controllers.GetStudents)
    }

    r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

    r.Run()
}

这是我有 GET 方法的端点：

package controllers

import (
    "gowebservice/config"
    "gowebservice/models"
    "net/http"

    "github.com/gin-gonic/gin"
)

// GetStudents godoc
// @Summary Show a list of students
// @Accept  json
// @Produce  json
// @Router /students [get]
func GetStudents(c *gin.Context) {
    var students []models.Student

    if err := config.DB.Find(&students).Error; err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": "Record not found!"})
        return
    }
    c.JSON(http.StatusOK, students)
}

当我使用swag init和 时go run main.go，Swagger UI 仍然显示示例而不是我的端点。

有人可以帮助我吗？

Answer 1

我也遇到了这个

问题是我们导入了基本示例文档：

import (
    ...

    _ "github.com/swaggo/gin-swagger/example/basic/docs"
)

您需要将其更改为由 生成的文档包swag init。假设您的模块名称是gowebservice，那么：

import (
    ...

    _ "gowebservice/docs"
)

go run main.go之后运行应该会让 Swagger UI 找到您自己的文档！：D