> swagger可以很好的為Api提供文檔,并且加強代碼的注釋能力
[TOC]
## 安裝 swag
~~~
go get -u github.com/swaggo/swag/cmd/swag
~~~
> 若 `$GOROOT/bin` 沒有加入`$PATH`中,你需要執行將其可執行文件移動到`$GOBIN`下
~~~
swag -v
# 安裝成功返回 swag version v1.7.0
~~~
## 編寫swagger注解
~~~
package main
import (
_ "ginw/docs"
"github.com/gin-gonic/gin"
"github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
"net/http"
)
// @Summary 打印測試功能
// @title Swagger Example API
// @version 0.0.1
// @description This is a sample server Petstore server.
// @BasePath /api/v1
// @Host 127.0.0.1:8080
// @Produce json
// @Param name query string true "Name"
// @Success 200 {string} json "{"code":200,"data":"name","msg":"ok"}"
// @Router /api/v1/haha [get]
func Print(context *gin.Context) {
var (
name string
)
name = context.Query("name")
context.JSON(http.StatusOK, gin.H{
"code": http.StatusOK,
"msg": "success",
"data": name,
})
}
func main() {
var (
route *gin.Engine
v1 *gin.RouterGroup
)
route = gin.Default()
route.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
//gin.SetMode(gin.ReleaseMode)
v1 = route.Group("/api/v1")
{
v1.GET("haha", Print)
}
route.Run()
}
~~~
## 生成注解文檔
> 在項目根目錄中執行
~~~
swag init
~~~
> 訪問 http://localhost:8080/swagger/index.html
**參考文獻**
> https://www.bbsmax.com/A/lk5amD4451/
> https://blog.csdn.net/eddycjy/article/details/106740800
- 基礎知識
- 開發環境
- 包名規則
- 包初始化 (init)
- 基礎數據類型
- 基礎類型轉換
- 格式化輸出
- go指針
- 流程控制語句
- 函數定義
- 匿名函數
- 數組和切片
- map集合
- 結構體
- Interface接口
- 日期處理
- 數學計算
- 正則表達式
- 協程 (并發處理)
- channel
- waitgroup
- mutex (鎖機制)
- websocket
- protobuf
- Redis
- 錯誤處理
- 打包程序
- NSQ消息隊列
- 單元測試
- beego
- 安裝入門
- Gin
- 快速入門
- 路由與控制器
- 處理請求參數
- 表單驗證
- 處理響應結果
- 渲染HTML模版
- 訪問靜態文件
- Gin中間件
- Cookie處理
- Session處理
- Gin上傳文件
- swagger
- pprof性能測試
- GORM
- 入門教程
- 模型定義
- 數據庫連接
- 插入數據
- 查詢數據
- 更新數據
- 刪除數據
- 事務處理
- 關聯查詢
- 屬于 (BELONG TO)
- 一對一 (Has One)
- 一對多 (Has Many)
- 多對多 (Many to Many)
- 預加載 (Preloading)
- 錯誤處理
- 第三方常用插件
- viper 讀取配置文件
- zap 高性能日志
- Nginx代理配置
- Goland 快捷鍵