常用的注释用法：
- @title: 指定 API 的标题。
- @description: 对 API 的简要描述。
- @version: API 的版本号。
- @termsOfService: API 的使用条款。
- @contact: API 的联系方式，例如邮箱。
- @license: API 的许可证信息。
- @host: API 的主机名和端口号。
- @BasePath: API 的基本路径。
- @Summary: 端点的摘要信息。
- @ID: 端点的唯一标识符。
- @Accept: 端点所接受的 MIME 类型。
- @Produce: 端点所产生的 MIME 类型。
- @Param: 端点的参数描述，包括参数名、位置、数据类型、是否必需等信息。
- @Success: 端点成功响应的描述，包括状态码、响应体等信息。
- @Router: 端点的路由信息。
不常用的注释用法：
- @Deprecated: 标记 API 或端点为已弃用的。
- @Tags: 标记端点所属的标签，用于组织文档。
- @Security: 端点的安全要求，例如需要的权限等信息。
- @ParamHeader: 描述请求头参数。
- @ParamQuery: 描述查询参数。
- @ParamForm: 描述表单参数。
- @ParamBody: 描述请求体参数。
posted @
2024-02-24 15:47
看一百次夜空里的深蓝
阅读(
188)
评论()
编辑
收藏
举报
