GO 使用swagger生成接口文檔

1.編寫完註釋後,使用以下命令安裝swag工具:

go get -u github.com/swaggo/swag/cmd/swag

2.在項目根目錄執行以下命令,使用swag工具生成接口文檔數據。

swag init

3.執行完上述命令後,如果你寫的註釋格式沒問題,此時你的項目根目錄下會多出一個docs文件夾。

4. 然後在項目代碼中註冊路由的地方按如下方式引入gin-swagger相關內容

 

_ "xxxx/docs"  // 千萬不要忘了導入把你上一步生成的docs
gs "github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
//swagger
router.GET("/swagger/*any", gs.WrapHandler(swaggerFiles.Handler))

5. 把你的項目程序運行起來,打開瀏覽器訪問http://localhost:8080/swagger/index.html就能看到Swagger 2.0 Api文檔了

 

6.

3、一些註解,編寫各API handler方法註釋(註解格式傳送門

1)main.go主程序文件註釋:

// @title xxx  API
// @version 1.0
// @description  Golang api of demo
// @termsOfService http://xxx.com

// @contact.name API Support
// @contact.url http://www.x.com
// @contact.email ×××@qq.com

//@host 127.0.0.1:8081
func main() {
}
 

2)方法註釋

 

// @Title 應用中心操作日誌
// @Author [email protected]
// @Description 獲取應用中心操作日誌
// @Tags operationlog
// @Param Authorization    header string true "Bearer 31a165baebe6dec616b1f8f3207b4273"
// @Param route formData string false "路由"
// @Param operator formData string false "操作者"
// @Param operation_type formData string false "操作類型 1 新增、2 刪除、3 更新"
// @Param description formData string false "操作描述"
// @Param start_time formData string false "開始時間"
// @Param end_time formData string false "結束時間"
// @Param page formData string true "頁數"
// @Param size formData string true "數據條數"
// @Success 200 {object} GetOperationLogListResponse
// @Router    /api/v1/xx/xx/appcenter [get]
func xxx(c *gin.Context) {
    
}
 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章