go-swagger 生成接口,注解说明 (注解为参数)

5 篇文章 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.其他属性

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

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger可以通过注解的方式来描述API的请求参数。常用的注解包括: - @Api:用于描述API的基本信息,包括名称、描述、版本等信息; - @ApiOperation:用于描述API的操作,包括HTTP方法、URL、操作名称、操作描述等信息; - @ApiParam:用于描述API的请求参数,包括参数名、数据类型、是否必填、默认值、描述等信息; - @ApiImplicitParam:用于描述API的请求参数,包括参数名、数据类型、是否必填、默认值、描述等信息; - @ApiImplicitParams:用于描述API的多个请求参数,可以包含多个@ApiImplicitParam注解; - @ApiModel:用于描述API的请求或响应参数的数据模型,包括模型名、字段、描述等信息; - @ApiModelProperty:用于描述API的请求或响应参数的数据模型的字段,包括字段名、数据类型、描述等信息。 例如,以下是一个使用Swagger注解的示例: ``` @RestController @Api(tags = "用户管理") @RequestMapping("/api/users") public class UserController { @GetMapping("/{id}") @ApiOperation(value = "根据ID获取用户信息", notes = "根据用户ID获取用户信息") public User getUserById(@PathVariable Long id) { // ... } @PostMapping @ApiOperation(value = "创建用户", notes = "创建新用户") public User createUser(@ApiParam(name = "用户信息", value = "用户对象", required = true) @RequestBody User user) { // ... } } ``` 在上面的示例中,@Api注解描述了API的基本信息,@ApiOperation注解描述了API的操作信息,@ApiParam注解描述了请求参数的信息。这些注解可以帮助开发者更好地理解API的含义和用法,提高API的可读性和可维护性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值