专栏首页国产程序员SwaggerAPI注解详解

SwaggerAPI注解详解

@Api

作用在类上,用来标注该类具体实现内容。表示标识这个类是swagger的资源

参数:

  1. tags:可以使用tags()允许您为操作设置多个标签的属性,而不是使用该属性。
  2. description:可描述描述该类作用。

@ApiImplicitParam

作用在方法上,表示单独的请求参数

参数:

  1. name :参数名。
  2. value : 参数的具体意义,作用。
  3. required : 参数是否必填。
  4. dataType :参数的数据类型。
  5. paramType :查询参数类型,这里有几种形式

@ApiImplicitParams

用于方法,包含多个 例:

@ApiImplicitParam
@ApiImplicitParams({ 
        @ApiImplicitParam(name = "id", 
                          value = "book's name", 
                          required = true, 
                          dataType = "Long", 
                          paramType = "query"),
        @ApiImplicitParam(name = "date", 
                          value = "book's date",
                          required = false, 
                         dataType = "string", 
                         paramType = "query")})

@ApiModel

用于类,表示对类进行说明,用于参数用实体类接收

@ApiModelProperty

用于方法,字段 ,表示对model属性的说明或者数据操作更改 例:

@ApiModel(
         value = "User", description = "用户")

    public class User implements Serializable{

    private static final long serialVersionUID = 1546481732633762837L;

    /**
     * 用户ID
     */
    @ApiModelProperty(value = "用户ID", required = true)
    @NotEmpty(message = "{id.empty}", groups = {Default.class,New.class,Update.class})
    protected String id;

    /**
     * code/登录帐号
     */
    @ApiModelProperty(value = "code/登录帐号")
    @NotEmpty(message = "{itcode.empty}", groups = {Default.class,New.class,Update.class})
    protected String itcode;

    /**
     * 用户姓名
     */
    @ApiModelProperty(value = "用户姓名")
    @NotEmpty(message = "{name.empty}", groups = {Default.class,New.class,Update.class})
    protected String name;

@ApiOperation

用于方法,表示一个http请求的操作 。

@ApiOperation(value = "获取图书信息", 
              notes = "获取图书信息", 
              response = Book.class, 
              responseContainer = "Item", 
              produces = "application/json") 
    @ApiImplicitParams({ 
        @ApiImplicitParam(
              name = "id", 
              value = "book's name", 
              required = true, 
              dataType = "Long", 
              paramType = "query"), 
        @ApiImplicitParam(
              name = "date", 
              value = "book's date", 
              required = false, 
              dataType = "string",
              paramType = "query")})
       @RequestMapping(
              value = "/{id}", 
              method = RequestMethod.GET) 
              @ResponseBody 
              public Book getBook(@PathVariable Long id, String date) { 
                  return books.get(id); 
               }

@ApiResponse

用于方法,描述操作的可能响应。

@ApiResponses

用于方法,一个允许多个ApiResponse对象列表的包装器。 例:

@ApiResponses(value = { @ApiResponse(code = 500, message = "2001:因输入数据问题导致的报错"),
            @ApiResponse(code = 500, message = "403:没有权限"),
            @ApiResponse(code = 500, message = "2500:通用报错(包括数据、逻辑、外键关联等,不区分错误类型)")})

@ApiParam

用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等)

@Authorization

声明要在资源或操作上使用的授权方案。

@AuthorizationScope

介绍一个OAuth2授权范围。

@ResponseHeader

响应头设置,使用方法。

本文分享自微信公众号 - 国产程序员(Monday_lida),作者:看似无限透明的你

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-04-02

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • JWT简介

    JSON Web Token(JWT)是目前最流行的跨域身份验证解决方案。微服务常见的认证方案

    一觉睡到小时候
  • Memcached三种客户端的使用

    注:该方式与第一种类似,只是在set方法的时候,传入参数顺序调换。缓存时间需注意,若memcached的服务端装在windows上,可能会出现运行错误。

    一觉睡到小时候
  • Excel也能制作二维码

    现在二维码广泛流行,各种各样的地方都需要扫码。二维码不光能使用代码来实现,也可以通过Excel来制作二维码。

    一觉睡到小时候
  • Mysql update多表联合更新

    下面我建两个表,并执行一系列sql语句,仔细观察sql执行后表中数据的变化,很容易就能理解多表联合更新的用法

    周小董
  • 【DUBBO】 Schema解析Spring扩展机制集成Spring

    dubbo是如何做到与spring集成的?这都依赖于Spring提供的XML Schema可扩展机制,用户可以自定义XML Schema文件,并自定义XML B...

    spilledyear
  • MyBatis (一) MyBatis 的简单引入

    创建数据库 首先,我们先创建一个数据库,表名为 tbl_employee, 该表的字段以及类型如下

    求和小熊猫
  • Python中动态创建类实例

    kongxx
  • python读取sqlite文件

    py3study
  • 冷门干货 你知道Android 中1px的字到底有多高?

    在还原UI的时候我们常会发现一个问题,按照Sketch标注的尺寸去还原设计稿中的文字会产生几个Px的误差,字符上下有些许空白,以致于后期设计审查时频繁微调。

    Android技术干货分享
  • 简单谈谈java中匿名内部类构造函数

    public static void main(String[] args) {List l1 = new ArrayList();List l2 = new ...

    用户7886150

扫码关注云+社区

领取腾讯云代金券