[TOC] > [github](https://github.com/swaggo/swag/blob/master/README_zh-CN.md) ## 概述 Swag將Go的注釋轉換為Swagger2.0文檔 **支持的Web框架** * [gin](http://github.com/swaggo/gin-swagger) * [echo](http://github.com/swaggo/echo-swagger) * [buffalo](https://github.com/swaggo/buffalo-swagger) * [net/http](https://github.com/swaggo/http-swagger) ## 安裝命令 ``` go install github.com/swaggo/swag/cmd/swag@latest ``` ## 語法 ``` swag init -h NAME: swag init - Create docs.go USAGE: swag init [command options] [arguments...] OPTIONS: --generalInfo value, -g value API通用信息所在的go源文件路徑，如果是相對路徑則基于API解析目錄 (默認: "main.go") --dir value, -d value API解析目錄 (默認: "./") --exclude value 解析掃描時排除的目錄，多個目錄可用逗號分隔（默認：空） --propertyStrategy value, -p value 結構體字段命名規則，三種：snakecase,camelcase,pascalcase (默認: "camelcase") --output value, -o value 文件(swagger.json, swagger.yaml and doc.go)輸出目錄 (默認: "./docs") --parseVendor 是否解析vendor目錄里的go源文件，默認不 --parseDependency 是否解析依賴目錄中的go源文件，默認不 --markdownFiles value, --md value 指定API的描述信息所使用的markdown文件所在的目錄 --generatedTime 是否輸出時間到輸出文件docs.go的頂部，默認是 --codeExampleFiles value, --cef value 解析包含用于 x-codeSamples 擴展的代碼示例文件的文件夾，默認禁用 --parseInternal 解析 internal 包中的go文件，默認禁用 --parseDepth value 依賴解析深度 (默認: 100) --instanceName value 設置文檔實例名 (默認: "swagger") swag fmt -h NAME: swag fmt - format swag comments USAGE: swag fmt [command options] [arguments...] OPTIONS: --dir value, -d value API解析目錄 (默認: "./") --exclude value 解析掃描時排除的目錄，多個目錄可用逗號分隔（默認：空） --generalInfo value, -g value API通用信息所在的go源文件路徑，如果是相對路徑則基于API解析目錄 (默認: "main.go") --help, -h ```