Golang Swag 注释

常用的注释用法:

  1. @title: 指定 API 的标题。
  2. @description: 对 API 的简要描述。
  3. @version: API 的版本号。
  4. @termsOfService: API 的使用条款。
  5. @contact: API 的联系方式,例如邮箱。
  6. @license: API 的许可证信息。
  7. @host: API 的主机名和端口号。
  8. @BasePath: API 的基本路径。
  9. @Summary: 端点的摘要信息。
  10. @ID: 端点的唯一标识符。
  11. @Accept: 端点所接受的 MIME 类型。
  12. @Produce: 端点所产生的 MIME 类型。
  13. @Param: 端点的参数描述,包括参数名、位置、数据类型、是否必需等信息。
  14. @Success: 端点成功响应的描述,包括状态码、响应体等信息。
  15. @Router: 端点的路由信息。

不常用的注释用法:

  1. @Deprecated: 标记 API 或端点为已弃用的。
  2. @Tags: 标记端点所属的标签,用于组织文档。
  3. @Security: 端点的安全要求,例如需要的权限等信息。
  4. @ParamHeader: 描述请求头参数。
  5. @ParamQuery: 描述查询参数。
  6. @ParamForm: 描述表单参数。
  7. @ParamBody: 描述请求体参数。
posted @   看一百次夜空里的深蓝  阅读(259)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· DeepSeek 开源周回顾「GitHub 热点速览」
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
· AI与.NET技术实操系列(二):开始使用ML.NET
· 单线程的Redis速度为什么快?
历史上的今天:
2022-02-24 Javascript 正则使用笔记
2022-02-24 gitlab root密码重置
点击右上角即可分享
微信分享提示