主页 / 问题 / 1534811
Accepted
Willy Durt
Asked:2023-08-08 14:54:12 +0000 UTC2023-08-08 14:54:12 +0000 UTC

localhost:8080/swagger/index.html 返回 404 页面未找到 (swaggo)

  • 772

我正在为在 golang 中实现的 REST API 编写文档，我决定使用 swag 库，其描述位于此链接https://github.com/swaggo/swag，我按照说明和要点做了所有事情，首先我在代码中添加了注释，然后我下载了 go install github.com/swaggo/swag/cmd/swag@latest，然后我运行了 swag init，它生成了文档，之后我运行了 go run mai.go 代码并逻辑上http://localhost:8080/swagger/index.html 上应该有文档，但它返回 404 页面未找到。也许有人已经遇到过类似的问题，请告诉我们什么先决条件可以导致这一刻或者我可能错过了 main.go 的内容：

package main

import (
    "api/Routes"
)

const version = "1.0.0"

//@title REST API
//@version 1.0.0
//@description My REST API
// @contact.name contact to developers
// @contact.email example@gmail.com
// @host localhost:8080
// @BasePath /api/v1
func main() {
    Routes.BaseRouter()
}

其他项目都被禁用，所以只有他可以监听8080端口

这是 api\Routes：

package Routes

    import (
        "api/Handlers"
        "log"
    
        "github.com/gin-contrib/cors"
        "github.com/gin-gonic/gin"
    )
    
    func BaseRouter() {
        router := gin.Default()
        router.Use(cors.Default())
        router.POST("/api/v1/orders", Handlers.PostOrders)
        router.GET("/api/v1/orders/:orderId/boxes", Handlers.GetBoxes)
    
        err := router.Run("localhost:8080")
        if err != nil {
            log.Println("Error running router: ", err)
        }
    
    }
golang

1 个回答

  1. Best Answer

    错误是我没有考虑到使用了 gin 库，所以这里是导入生成的文档的更正部分，swaggerFiles“github.com/swaggo/files”，ginSwagger“github.com/swaggo/gin” -swagger" ，以及用于获取文档的新端点

    package Routes

import (
    "api/Handlers"
    "log"

    _ "api/docs"

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

func BaseRouter() {
    router := gin.Default()
    router.Use(cors.Default())
    router.GET("swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
    router.POST("/api/v1/orders", Handlers.PostOrders)
    router.GET("/api/v1/orders/:orderId/boxes", Handlers.GetBoxes)

    err := router.Run("localhost:8080")
    if err != nil {
        log.Println("Error running router: ", err)
    }

}
    • 0

相关问题