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/