go-swagger 生成接口,注解说明 (注解为参数)
创始人
2024-05-29 18:09:11
0

// Index

// @Summary 后台登陆页

// @Tags 后台-登陆功能

// @param name formData string false "用户名"

// @param pwd formData string false "密码"

// @param keyid formData string false "验证码是对应key"

// @param base64s formData string false "验证码"

// @Success 200 {string} json{"code","message"}

// @Router /admin/login/index [POST]

swag注解说明

@Tags: 分类信息,用逗号分割多个,写多个的话,在api文档里面会生成多个接口

@Summary: 操作的简短摘要。

@Accept json

@Produce json

@Param:参数信息,用空格分隔的参数。

param name type data type is mandatory comment attribute(optional)
1.参数名,2.参数类型,3.参数数据类型,4.是否必须,5.参数描述,6.其他属性

1.参数名

参数名就是我们解释参数的名字。

2.参数类型,可以有的值是 query、path、body、header,formData

  • query 表示带在 url 之后的参数

  • path 表示请求路径上得参数

  • body 表示是一个 raw 数据请求,当Accept是JSON格式时,我们使用该字段指定接收的JSON类型

  • header 表示带在 header 信息中得参数

  • formData 表示是 post 请求的数据

3.参数数据类型

数据类型主要支持以下几种:

  • string (string)

  • integer (int, uint, uint32, uint64)

  • number (float32)

  • boolean (bool)

  • 自定义struct

4.是否必须

5.参数描述

就是参数的一些说明,注释

6.其他属性

除了上面这些属性外,我们还可以为该参数填写一些额外的属性,如枚举,默认值,值范围等。

相关内容

热门资讯

监控摄像头接入GB28181平... 流程简介将监控摄像头的视频在网站和APP中直播,要解决的几个问题是:1&...
Windows10添加群晖磁盘... 在使用群晖NAS时,我们需要通过本地映射的方式把NAS映射成本地的一块磁盘使用。 通过...
protocol buffer... 目录 目录 什么是protocol buffer 1.protobuf 1.1安装  1.2使用...
在Word、WPS中插入AxM... 引言 我最近需要写一些文章,在排版时发现AxMath插入的公式竟然会导致行间距异常&#...
【PdgCntEditor】解... 一、问题背景 大部分的图书对应的PDF,目录中的页码并非PDF中直接索引的页码...
修复 爱普生 EPSON L4... L4151 L4153 L4156 L4158 L4163 L4165 L4166 L4168 L4...
Fluent中创建监测点 1 概述某些仿真问题,需要创建监测点,用于获取空间定点的数据࿰...
educoder数据结构与算法...                                                   ...
MySQL下载和安装(Wind... 前言:刚换了一台电脑,里面所有东西都需要重新配置,习惯了所...
MFC文件操作  MFC提供了一个文件操作的基类CFile,这个类提供了一个没有缓存的二进制格式的磁盘...