首页 > 其他分享 >Golang Swag 注释

Golang Swag 注释

时间:2024-02-24 15:56:19浏览次数:26  
标签:注释 Swag 信息 Golang API 参数 端点 描述

常用的注释用法:

  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: 描述请求体参数。

标签:注释,Swag,信息,Golang,API,参数,端点,描述
From: https://www.cnblogs.com/watermeloncode/p/18031159

相关文章

  • vs2010 快捷键 注释
        3.写代码时经常要注释一些代码,测试,然后再取消注释,反复如此,可以记住这两个快捷键,按Ctrl+K,Ctrl+C注释代码,按Ctrl+K,Ctrl+U取消注释。可以在开发中不用将手在键盘和鼠标间移来移去,是一件多么惬意的事啊。这时候还可以配合Shift+上下键头,可以选择多行。就此告别用鼠标选......
  • golang中协程&管道&锁
    进程和线程进程(Process)就是程序在操作系统中的一次执行过程,是系统进行资源分配和调度的基本单位,进程是一个动态概念,是程序在执行过程中分配和管理资源的基本单位,每一个进程都有一个自己的地址空间。一个进程至少有5种基本状态,它们是:初始态,执行态,等待状态,就绪状态,终止状态,通......
  • 《Linux内核完全注释》(3)
    关于博客:当公开学习笔记写,如果对于有感想的地方就发散一下,没有感想的地方就了解学习一下。总之这个笔记不能代替书,也不是那种总结手册,更像是学习日记,请各位朋友理解。3.4C与汇编程序相互调用在Linux内核程序boot/head.s执行完基本初始化操作之后,就会跳转去执行init/main.c......
  • golang中的接口(数据类型)
    golang中的接口Golang中的接口是一种抽象数据类型,Golang中接口定义了对象的行为规范,只定义规范不实现。接口中定义的规范由具体的对象来实现,通俗的讲接口就一个标准,它是对一个对象的行为和规范进行约定,约定实现接口的对象必须得按照接口的规范接口的定义在go中接口(int......
  • golang中的类型断言,解释.(float64)和.(string)
    在Go语言中,. 后跟括号中的类型名称(如 .(float64) 或 .(string))通常出现在类型断言(typeassertion)的上下文中。类型断言用于检查一个空接口(interface{})值是否包含特定的类型,如果是,则将其转换为该类型。类型断言的语法如下:value,ok:=x.(T)其中 x 是一个 interface{}......
  • Golang Gorm 的标签tag
    当使用GORM进行数据库模型映射时,可以使用多种标签来定义字段的行为。以下是一些常用的GORM标签:gorm:"primary_key":定义字段作为模型的主键。gorm:"column:<column_name>":指定字段在数据库表中的列名。gorm:"type:<data_type>":指定字段的数据库数据类型。gorm:"......
  • golang 读取excel 保存xml
    1、首先下载第三方excel读取库gogetgithub.com/xuri/excelize/v22、读取xml库,未使用默认xml库 gogetgithub.com/beevik/etreepackagemainimport( "fmt" "github.com/beevik/etree" "github.com/xuri/excelize/v2")funcLoadExcelAndSaveXML(){ ......
  • golang 包&go mod
    gomod初始化项目gomodinit项目开发中首先要在项目目录中用gomod命令生成一个go.mod文件管理项目的依赖自定义包自定义包://自定义包一定要放在第一行packagecalc/*定义的方法、变量、结构体等首字母大写表示公有方法,其他包中可以引入该方法首字母小......
  • 关于Golang中函数的接收者不同对接口的使用的影响理解
    对于函数而言:接收者为指针会改变接收者本身的值接收者为值则只是拷贝,不会改变原本的值并且值和指针可以任意调用对方的方法,即值可以调用接收者为指针的方法,指针可以调用接收者为值得方法。原因是:可以自动指针解引用和值寻址对于接口而言:接收者为指针的方法,不能将值赋值给接......
  • golang指针和结构体
    指针指针操作指针包括指针地址、指针类型和指针取值&:&符号放在变量前面进行取地址操作**:*放在变量前面根据地址进行取值指针地址:funcmain(){ varaint=1 //a的值是1--类型是int--,地址是0xc0000120c0,&是地址符号 fmt.Printf("a的值是%v--类型是%T--,地......