swagger注解。

本文详细介绍了API文档中各类注解的使用方法,包括类注解、方法注解、参数注释、响应信息注释及实体类注解等,帮助开发者更好地理解并应用这些注解来规范API文档。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

  • 类注解
  • @Api(类注解)
    • value

表示类的链接地址,访问此类的URL中需要加/,必填。

  • description

表示类描述信息,选填。

  • produces

表示返回数据结构,选填。

  • 方法注解
  • @ApiOperation(方法注释)
    • value

表示访问此方法的链接地址,必填。

  • notes

表示方法的描述,选填。

  • httpMethod

表示请求方式,选填。

  • consumes

表示请求数据结构,选填。

  • produces

表示响应数据结构,选填。

  • @ApiImplicitParams(参数注释集)
    • ApiImplicitParam(参数注释)
      • paramType

        表示参数位置,可填值有body、head、path、query、form。

      • name

表示参数名。

  • required

表示是否必填。

  • value

表示参数描述。

  • dataType

表示参数类型。

  • @ApiResponses(响应信息注释集)
    • @ApiResponse(响应信息注释)
      • code

        表示响应码。

      • message

表示响应码解释。

  • response

表示返回类。

  • 实体类注解
  • @ApiModel(实体类注解)
    • value

      表示对象名称。

    • description

                 表示描述。

  • @ApiModelProperty(实体类字段注释)

    • value

表示字段名。

  • required

表示是否必填。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

软件求生

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值