Swaggo(github.com/swaggo/swag
)的注解語法是基于 OpenAPI 2.0 (以前稱為 Swagger 2.0) 規范的,并添加了一些自己的約定。
主要官方文檔:
swaggo/swag
GitHub 倉庫: 這是最權威的來源。- 鏈接: https://github.com/swaggo/swag
- 重點關注:
README.md
: 包含了基本的安裝、使用方法和一些簡單的注解示例。README_zh-CN.md
(如果有并且您偏好中文): 中文版說明。Specifictions.md
(或者類似名稱的文件,有時在docs
目錄下): 這里會詳細解釋所有支持的注解,例如@Summary
,@Description
,@Tags
,@Accept
,@Produce
,@Param
,@Success
,@Failure
,@Router
,@Security
,@Schemes
, 全局注解如@title
,@version
,@description
,@contact.*
,@license.*
,@host
,@BasePath
等。Examples
: 倉庫中通常會有一個examples
目錄,里面有不同框架(如 Gin, Echo)的示例項目,這些是學習如何組織注解的絕佳材料。
關鍵注解概覽 (基于您目前項目中的使用情況和通用需求):
-
全局 API 信息 (通常在
main.go
或一個專門的docs.go
文件頂部,包級別注釋):// @title Your API Title
// @version 1.0
// @description A detailed description of your API.
// @termsOfService http://example.com/