Spring Boot中使用Swagger

1. 启用Swagger
1.1 启用注解扫描和文档接口

直接在POM文件引入依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
1.2 启动swagger-ui

目前看到的选项有2个:

  • swaager-ui ，访问地址: http://127.0.0.1:18080/swagger-ui.html
    <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>
  • swagger-bootstrap-ui ，也叫knife4j ，访问地址: http://127.0.0.1:18080/doc.html
    <dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>${lastVersion}</version></dependency>

我更喜欢swagger-bootstrap-ui的风格

1.3 创建Swagger配置类
    @Configuration@EnableSwagger2public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//                .apis(RequestHandlerSelectors.any()).apis(RequestHandlerSelectors.basePackage("com.dwpro")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("标题lws") //标题.description("简介lws") //简介.termsOfServiceUrl("服务条款lws") //服务条款.contact(new Contact("randy", "", "randy@gmail.com")).version("1.0.lws") //版本.build();}}

在这里插入图片描述

2. 注解
2.1 @Api

@Api注解在Controller上，通过tags指定指定名称(左侧菜单的名称)，tags可以指定多个值，多种使用场景通过指定相同的tag值将所有的API分组在一起。

@Api还有value和description属性，description已经@Deprecated，value号称会被当成tags值，实际测试下来无效

    @RestController@RequestMapping("/v1")@Api(tags = {"测试Swagger的注解使用"})public class HelloworldController {}

在这里插入图片描述

2.2 @ApiOperation

@ApiOperation用于注解到Controller上的方法，对应一个对外提供的接口。目前有4个属性:

属性描述
value对操作的简单说明
notes对操作的详细说明
httpMethodHTTP请求类型，可选:GET HEAD POST PUT DELETE OPTIONS PATCH
codeHTTP状态码，默认为200
produces输出的Content-Type
consumes输入的Content-Type

示例

    @RequestMapping("say")@ApiOperation(value = "用于打印用户输入信息", notes = "这是个什么鬼啊啊啊", httpMethod = "GET")public String say(@RequestParam("message") String message) {return message;}

在这里插入图片描述

2.3 @ApiParam
属性描述
name参数名称，因此这个一般应该是字母
value参数说明
defaultValue参数默认值
required参数是否必须

参数类型会通过反射获取，如果参数是基本类型会显示在数据类型字段，如果参数是自定义的类，会同时显示在数据类型和schema字段

2.3.1 示例: query param

基本上只有value字段对接收说明有意义， example字段是在页面上调试给的示例值

@RequestMapping("say")
@ApiOperation(value = "用于打印用户输入信息", notes = "这是个什么鬼啊啊啊", httpMethod = "GET")
public String say(@ApiParam(value = "参数描述", example = "10086") @RequestParam("message") Integer message) {return "";
}

在这里插入图片描述

2.3.2 示例: 使用请求体，并用一个对象接收参数

使用@RequestBody的场景下，指定@ApiParam唯一有用的属性的value，指定其他参数没有效果

    @PostMapping("say2")@ApiOperation(value = "测试请求体", notes = "这是个什么鬼啊啊啊", httpMethod = "POST")public String say2(@ApiParam(value = "参数描述") @RequestBody ApFissionLog apFissionLog) {return "";}

在这里插入图片描述

2.4 @ApiImplicitParams 和 @ApiImplicitParam

和@ApiParam相同作用，但是不把注解混合到代码内部，可读性更强，个人更喜欢这种方式

    @PostMapping("say3")@ApiImplicitParams({@ApiImplicitParam(name = "cavatar",value = "value1",example = "10001", dataType = "int", paramType = "query"),@ApiImplicitParam(name = "cnickname",value = "value2",example = "example2", dataType = "string", paramType = "query")})public String say3(@RequestParam("cavatar") String cavatar, @RequestParam("cnickname") String cnickname) {return "";}

在这里插入图片描述

2.5 @ApiResponse

定义接口的返回值，示例中say4和say5方法的表现基本一致，没发现注解的特殊意义

属性描述
codeHTTP状态码
message状态码的文本描述
response返回值的class
responseContainer返回容器类型时使用，有效值: List Set Map
    @PostMapping("say4")public ApFissionLog say4(@RequestParam("cavatar") String cavatar, @RequestParam("cnickname") String cnickname) {return new ApFissionLog();}@PostMapping("say5")@ApiResponse(code = 200,message = "返回描述", response = ApFissionLog.class)public ApFissionLog say5(@RequestParam("cavatar") String cavatar, @RequestParam("cnickname") String cnickname) {return new ApFissionLog();}
2.6 @ApiModel和@ApiModelProperty

当请求和响应是POJO的时候特别有用，现实场景中这又是最常用的情况。

@ApiModel用于指定POJO类的描述，提供更可读的类型名称(这个个人觉得没用，直接展示现有类名挺好)。

属性描述
valuemodel的别名，默认为类名
descriptionmodel的详细描述

@ApiModelProperty用于描述POJO里的字段

属性描述
value属性简短描述
example属性的示例值
required是否为必须值
    @PostMapping("say6")@ApiOperation(value = "测试请求体", notes = "这是个什么鬼啊啊啊", httpMethod = "POST")public ApFissionLog say6(@RequestBody ApFissionLog apFissionLog) {return new ApFissionLog();}

通过在ApFissionLog类上添加注解


@ApiModel(value = "model类名字", description = "描述信息")
public class ApFissionLog {@ApiModelProperty(value = "C用户的昵称", notes = "notes", example = "AAA-BBB-CCC", required = true)private String cnickname;@ApiModelProperty(value = "C用户的头像", notes = "notes", example = "http://www.aaa.com/avtar.png", required = true)private String cavatar;}

在这里插入图片描述

3. API分组

通过在Swagger的配置类里创建两个Docket对象，扫描不同的包就能完成分组

@Configuration
@EnableSwagger2
public class SwaggerConfig {@Bean("defaultApi")public Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("分组1").select()
//                .apis(RequestHandlerSelectors.any()).apis(RequestHandlerSelectors.basePackage("com.dwpro")).paths(PathSelectors.any()).build();}@Bean("groupApi")public Docket createGroupApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("分组2").select()
//                .apis(RequestHandlerSelectors.any()).apis(RequestHandlerSelectors.basePackage("com.dwpro")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("标题lws") //标题.description("简介lws") //简介.termsOfServiceUrl("服务条款lws") //服务条款.contact(new Contact("randy", "", "randy@gmail.com")).version("1.0.lws") //版本.build();}
}

在这里插入图片描述

4. 完整示例
4.1 pom.xml 添加依赖
    <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.6</version></dependency>
4.2 Swagger Config 类
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Bean("defaultApi")public Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("分组1").select()
//                .apis(RequestHandlerSelectors.any()).apis(RequestHandlerSelectors.basePackage("com.dwpro")).paths(PathSelectors.any()).build();}@Bean("groupApi")public Docket createGroupApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("分组2").select()
//                .apis(RequestHandlerSelectors.any()).apis(RequestHandlerSelectors.basePackage("com.dwpro")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("标题lws") //标题.description("简介lws") //简介.termsOfServiceUrl("服务条款lws") //服务条款.contact(new Contact("randy", "", "randy@gmail.com")).version("1.0.lws") //版本.build();}
}
4.3 Controller类
    @RestController@RequestMapping("/v1")@Api(tags = {"测试Swagger的注解使用"})public class HelloworldController {@RequestMapping("say1")@ApiOperation(value = "用于打印用户输入信息", notes = "这是个什么鬼啊啊啊", httpMethod = "GET")public String say1(@ApiParam(value = "参数描述", example = "10086") @RequestParam("message") Integer message) {return "";}@PostMapping("say2")@ApiOperation(value = "测试请求体", notes = "这是个什么鬼啊啊啊", httpMethod = "POST")public String say2(@ApiParam(value = "参数描述") @RequestBody ApFissionLog apFissionLog) {return "";}@PostMapping("say3")@ApiImplicitParams({@ApiImplicitParam(name = "cavatar",value = "value1",example = "10001", dataType = "int", paramType = "query"),@ApiImplicitParam(name = "cnickname",value = "value2",example = "example2", dataType = "string", paramType = "query")})public String say3(@RequestParam("cavatar") String cavatar, @RequestParam("cnickname") String cnickname) {return "";}@PostMapping("say4")public ApFissionLog say4(@RequestParam("cavatar") String cavatar, @RequestParam("cnickname") String cnickname) {return new ApFissionLog();}@PostMapping("say5")@ApiResponse(code = 200,message = "返回描述", response = ApFissionLog.class)public ApFissionLog say5(@RequestParam("cavatar") String cavatar, @RequestParam("cnickname") String cnickname) {return new ApFissionLog();}@PostMapping("say6")@ApiOperation(value = "测试请求体", notes = "这是个什么鬼啊啊啊", httpMethod = "POST")public ApFissionLog say6(@RequestBody ApFissionLog apFissionLog) {return new ApFissionLog();}}
4.4 POJO类
    @Data@ApiModel(value = "model类名字", description = "描述信息")public class ApFissionLog {@ApiModelProperty(value = "C用户的昵称", notes = "notes", example = "AAA-BBB-CCC", required = true)private String cnickname;@ApiModelProperty(value = "C用户的头像", notes = "notes", example = "http://www.aaa.com/avtar.png", required = true)private String cavatar;}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/197327.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【Windows下】Eclipse 尝试 Mapreduce 编程

【Windows下】Eclipse 尝试 Mapreduce 编程

文章目录 配置环境环境准备连接 Hadoop查看 hadoop 文件 导入 Hadoop 包创建 MapReduce 项目测试 Mapreduce 编程代码注意事项常见报错 配置环境 环境准备 本次实验使用的 Hadoop 为 2.7.7 版本&#xff0c;实验可能会用到的文件 百度网盘链接&#xff1a;https://pan.baidu…
阅读更多...
Shopee过期的折扣活动如何删除？Shopee促销商品如何下架？——站斧浏览器

Shopee过期的折扣活动如何删除？Shopee促销商品如何下架？——站斧浏览器

商家们可以轻松删除虾皮过期活动以及下架促销商品&#xff0c;保持店铺的整洁和顾客的购物体验。那么shopee过期的折扣活动如何删除&#xff0c;shopee促销商品如何下架。 Shopee过期的折扣活动如何删除&#xff1f; 在删除虾皮过期活动时&#xff0c;商家们需要遵循以下步骤…
阅读更多...
Deployment脚本部署Tomcat集群：外部访问、负载均衡、文件共享及集群配置调整

Deployment脚本部署Tomcat集群：外部访问、负载均衡、文件共享及集群配置调整

文章目录 前置知识一、Deployment脚本部署Tomcat集群二、外部访问Tomcat集群三、利用Rinted对外提供Service负载均衡支持1、创建服务2、端口转发工具Rinetd3、定义jsp文件查看转发到哪个节点 四、部署配置挂载点五、基于NFS实现集群文件共享1、master2、node3、验证 六、集群配…
阅读更多...
Linux 进程

Linux 进程

文章目录 进程定义进程的描述查看进程方法进程状态进程优先级进程相关概念补充 进程定义 大多数的说法&#xff1a;进程是计算机中正在运行的程序的实例。它是操作系统对程序的一种抽象&#xff0c;用于管理和调度程序的执行。 个人理解: 从OS(操作系统)开始说起&#xff0c;…
阅读更多...
用户态和内核态

用户态和内核态

实际上任何Linux发行版(Centos/RedHat....)&#xff0c;其系统内核都是Linux。我们的应用都需要通过Linux内核与硬件交互。为了避免用户应用导致冲突甚至内核崩溃&#xff0c;用户应用与内核是分离的&#xff1a; 进程的寻址空间会划分为两部分&#xff1a;内核空间、用户空间。…
阅读更多...
记一次引入低版本包导致包冲突，表现为NoClassDefFoundError的故障

记一次引入低版本包导致包冲突，表现为NoClassDefFoundError的故障

简而言之&#xff0c;因为参考别的项目处理excel的代码if(org.apache.poi.hssf.usermodel.HSSFDateUtil.isCellDateFormatted(cell)) &#xff0c;为了使用这个HSSFDateUtil类我引入了依赖&#xff1a; <dependency><groupId>org.apache.poi</groupId><a…
阅读更多...
LED恒流开关调节器FP7123，提供稳定电流，提升LED产品效果！

LED恒流开关调节器FP7123，提供稳定电流，提升LED产品效果！

目录 一、FP7123概述 二、FP7123功能 LED恒流开关调节器FP7123的优势不仅仅在于提供稳定的电流&#xff0c;还包括以下几个方面&#xff1a; 三、应用领域 随着科技的不断发展&#xff0c;LED照明产品已经成为人们生活中不可或缺的一部分。然而&#xff0c;LED的亮度和稳定性…
阅读更多...
二维码智慧门牌管理系统升级解决方案：存疑地址轻松管理

二维码智慧门牌管理系统升级解决方案：存疑地址轻松管理

文章目录 前言一、存疑地址的统一管理二、数据查询、导出和编辑功能三、提交地址审核机制 前言 随着二维码智慧门牌管理系统在企业中的广泛应用&#xff0c;地址存疑成为了一个亟待解决的问题。为了帮助企业有效管理这些存疑地址&#xff0c;我们推出了升级解决方案&#xff0…
阅读更多...
解雇 Sam Altman 的背后故事；梦露转 180°秒变爱因斯坦丨 RTE 开发者日报 Vol.98

解雇 Sam Altman 的背后故事；梦露转 180°秒变爱因斯坦丨 RTE 开发者日报 Vol.98

开发者朋友们大家好&#xff1a; 这里是 「RTE 开发者日报」 &#xff0c;每天和大家一起看新闻、聊八卦。我们的社区编辑团队会整理分享 RTE &#xff08;Real Time Engagement&#xff09; 领域内「有话题的 新闻 」、「有态度的 观点 」、「有意思的 数据 」、「有思考的 文…
阅读更多...
Javaweb之Vue路由的详细解析

Javaweb之Vue路由的详细解析

5 Vue路由 5.1 路由介绍 将资代码/vue-project(路由)/vue-project/src/views/tlias/DeptView.vue拷贝到我们当前EmpView.vue同级&#xff0c;其结构如下&#xff1a; 此时我们希望基于4.4案例中的功能&#xff0c;实现点击侧边栏的部门管理&#xff0c;显示部门管理的信息&am…
阅读更多...
如何安装Wnmp并结合内网穿透实现外网远程访问内网服务

如何安装Wnmp并结合内网穿透实现外网远程访问内网服务

文章目录 前言1.Wnmp下载安装2.Wnmp设置3.安装cpolar内网穿透3.1 注册账号3.2 下载cpolar客户端3.3 登录cpolar web ui管理界面3.4 创建公网地址 4.固定公网地址访问 前言 WNMP是Windows系统下的绿色NginxMysqlPHP环境集成套件包&#xff0c;安装完成后即可得到一个Nginx MyS…
阅读更多...
抖音集团面试挂在2面，复盘后，决定二战.....

抖音集团面试挂在2面，复盘后，决定二战.....

先说下我基本情况&#xff0c;本科不是计算机专业&#xff0c;现在是学通信&#xff0c;然后做图像处理&#xff0c;可能面试官看我不是科班出身没有问太多计算机相关的问题&#xff0c;因为第一次找工作&#xff0c;字节的游戏专场又是最早开始的&#xff0c;就投递了&#xf…
阅读更多...
Android 实现环形进度条

Android 实现环形进度条

一、项目需求 项目中常常需要用到进度条&#xff0c;很简单&#xff0c;这儿做一个简单的总结和实现 二、实现控件 ProgressBar 三、实现代码 1、水平的进度条 xml布局代码&#xff1a; <ProgressBarandroid:id"id/rocketProgressBar"style"style/Wid…
阅读更多...
go语言使用代码示例

go语言使用代码示例

在Go语言中&#xff0c;使用HTTP代码示例可以帮助我们发送HTTP请求并处理HTTP响应。下面是一个简单的示例&#xff0c;演示了如何使用Go语言发送HTTP GET请求并处理响应。 go复制代码 package main import ( "fmt" "io/ioutil" "…
阅读更多...
【对抗算法代码实现】FGSM

【对抗算法代码实现】FGSM

FGSM 先训练一个神经网络的模型 LeNet 下载数据集并可视化 # 这句话的作用:即使是在Python2.7版本的环境下&#xff0c;print功能的使用格式也遵循Python3.x版本中的加括号的形式 from __future__ import print_functionimport torchvision from torch.utils.data import Da…
阅读更多...
Redis——简单动态字符串（Simple Dynamic Strings,SDS）

Redis——简单动态字符串（Simple Dynamic Strings,SDS）

简单动态字符串&#xff08;Simple Dynamic Strings,SDS&#xff09;是Redis的基本数据结构之一&#xff0c;用于存储字符串和整型数据。SDS兼容C语言标准字符串处理函数&#xff0c;且在此基础上保证了二进制安全。 1、数据结构 在了解SDS源码前&#xff0c;我们先思考一个问…
阅读更多...
【模电】设置静态工作点的必要性

【模电】设置静态工作点的必要性

设置静态工作点的必要性 静态工作点为什么要设置静态工作点 静态工作点 在放大电路中&#xff0c;当有信号输入时&#xff0c;交流量与直流量共存。将输入信号为零、即直流电源单独作用时晶体管的基极电流 I B I\tiny B IB、集电极电流 I C I\tiny C IC、b - e间电压 U B E U\t…
阅读更多...
oops-framework框架 之 Excel转Json

oops-framework框架 之 Excel转Json

引擎&#xff1a; CocosCreator 3.8.0 环境&#xff1a; Mac Gitee: oops-plugin-excel-to-json 注&#xff1a; 作者dgflash的oops-framework框架QQ群&#xff1a; 628575875 配置 作者dgflash在oops-framework的框架中&#xff0c;提供了关于Excel数据表转换为Json和TypeSc…
阅读更多...
对抗神经网络 CGAN实战详解 完整数据代码可直接运行

对抗神经网络 CGAN实战详解 完整数据代码可直接运行

代码视频讲解： 中文核心项目：对抗神经网络 CGAN实战详解 完整代码数据可直接运行_哔哩哔哩_bilibili 运行图： 完整代码： from keras.layers import Input, Dense, Reshape, Flatten, Dropout, multiply from keras.layers import BatchNormalization, Activation, Embedd…
阅读更多...
uniapp是否可以用vant等移动端UI库、使用步骤以及需要注意的问题

uniapp是否可以用vant等移动端UI库、使用步骤以及需要注意的问题

文章目录 使用vant步骤使用中遇到的问题在浏览器中的运行效果综上&#xff0c;不建议uniapp项目使用vant。 使用vant步骤 首先vant可以兼容uniapp&#xff0c;直接用vant版就好。微信小程序专用版本是&#xff1a;vant-weapp。 基本使用步骤&#xff1a; 1、安装 # 安装 Va…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023