Springfox Swagger2（二）：常用注解

忘是亡心i 2022-05-29 02:42 213阅读 0赞

**@ApiIgnore()：**用于类或者方法上，可以不被swagger显示在页面上

**@Api()：**用于类表示标识这个类是swagger的资源

tags–表示说明 但是tags如果有多个值，会生成多个list  
    value–也是说明，可以使用tags替代 （实际没有作用）

**@ApiOperation()：**用于方法；表示一个http请求的操作

value用于方法描述   
    notes用于提示内容   
    tags可以重新分组（视情况而用）

**@ApiImplicitParams()****：**用于方法，包含多个 @ApiImplicitParam

name–参数ming

value–参数说明

required 是否必须 boolean

dataType–数据类型

paramType–参数类型

body 使用@RequestBody接收数据 POST有效  
        path 在url中配置\{\}的参数  
        query 普通查询参数 例如 ?query=q ,jquery ajax中data设置的值也可以，例如 \{query:”q”\},springMVC中不需要添加注解接收  
        header 使用@RequestHeader接收数据  
        form 笔者未使用，请查看官方API文档

example–举例说明

**@ApiImplicitParam()****：** 用于方法 表示单独的请求参数

表示单独的请求参数

**@ApiResponses()：**用于表示一组响应

**@ApiResponse()：**用在@ApiResponses中，一般用于表达一个错误的响应信息

code：数字，例如400  
　 message：信息，例如"请求参数没填好"  
　 response：抛出异常的类

**@ApiParam()****：**用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等）

name–参数名   
    value–参数说明   
    required–是否必填

**@ApiModel()****：**用于类 表示对类进行说明，用于参数用实体类接收

value–表示对象名   
    description–描述   
    都可省略

**@ApiModelProperty()：**用于方法，字段 表示对model属性的说明或者数据操作更改

value–字段说明   
    required–是否必填   
    name–重写属性名字    
    dataType–重写属性类型  
    example–举例说明   
    hidden–隐藏

发表评论取消回复

表情：

评论列表（有 0 条评论，213人围观）

还没有评论，来说两句吧...

相关阅读

相关 Swagger基础（OpenAPI2 + SpringFox）

说明 Swagger 基础示例。使用 springfox 框架。依赖 <!-- 为解决Swagger启动报错，引入高版本 annotations 和

左手的ㄟ右手/ 2023年10月07日 22:30/ 0 赞/ 40 阅读

相关 SpringBoot+Swagger2常用注解

场景 SpringBoot+Swagger2实现可视化API文档流程： [https://blog.csdn.net/BADAO\_LIUMANG\_QIZHI/art

小鱼儿/ 2023年10月06日 13:45/ 0 赞/ 69 阅读

相关 SpringBoot整合Springfox-Swagger2

[SpringBoot整合Springfox-Swagger2 ][SpringBoot_Springfox-Swagger2] 前言不管Spring Boot

ゝ一世哀愁。/ 2023年01月04日 14:31/ 0 赞/ 234 阅读

相关 Swagger2 (2)由浅入深集成springboot + springfox-swagger

在使用Swagger2 的时候遇到很多坑爹的问题，这里我都会进行分享，还有一些Swagger2的进阶的知识。 1.解决@ApiImplicitParam 没有配置param

旧城等待，/ 2022年06月13日 00:49/ 0 赞/ 315 阅读

相关 Springfox Swagger2（二）：常用注解

@ApiIgnore()：用于类或者方法上，可以不被swagger显示在页面上 @Api()：用于类表示标识这个类是swagger的资源 tags–表示说

忘是亡心i/ 2022年05月29日 02:42/ 0 赞/ 214 阅读

相关 Springfox Swagger2（一）：概述

官网： http://springfox.github.io/springfox/ https://swagger.io/ GitHub：

不念不忘少年蓝@/ 2022年05月29日 02:15/ 0 赞/ 175 阅读

相关 Swagger常用注解

1.这里面有几个常用到的注解 @Api：用在类上，说明该类的作用 @ApiOperation：用在方法上，说明方法的作用，标注在具体请求上，value和notes的作用差

蔚落/ 2022年05月20日 00:12/ 0 赞/ 389 阅读

相关 springfox-swagger2 || rap

[一个介绍rap和swagger的网站][rap_swagger] rap是阿里自研的一个api工具，以前用过需要手写保存，给前端的是一个压缩后的md文件列表，没接触swa

矫情吗；*/ 2022年05月15日 11:39/ 0 赞/ 223 阅读

相关 Swagger2常用注解说明

这里只讲述@Api、@ApiOperation、@ApiImplicitParams、@ApiImplicitParam、@ApiParam、@ApiModel、@Ap

忘是亡心i/ 2022年02月04日 09:34/ 0 赞/ 367 阅读

相关 Swagger2常用注解说明

文章目录 Swagger2简介使用Swagger解决的问题 Spring Boot集成Swagger2 添加

末蓝、/ 2021年09月21日 09:34/ 0 赞/ 533 阅读