SpringBoot学习笔记(16)----SpringBoot整合Swagger2

Swagger 是一个规范和完整的框架,用于生成,描述,调用和可视化RESTful风格的web服务

  http://swagger.io

  Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller接口的方法以文档的形式展现,基于swagger,这样就方便开发人员不用在开发完接口服务之后还需要手写一份文档给需要的人。

  使用方式如下

  引入依赖:

  pom.xml文件

<dependency><groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency>

  编写配置类,并使用@EnableSwagger2开启支持swagger2,配置类如下

  

package com.wangx.boot.util;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import static springfox.documentation.builders.PathSelectors.regex; @Configuration @EnableSwagger2 public class Swagger2Configuration { @Bean public Docket accessToker() { return new Docket(DocumentationType.SWAGGER_2). groupName("api")//定一组 .select()//选择那些路径和接口api会生成document .apis(RequestHandlerSelectors.basePackage(""))//拦截的包 .paths(regex("/api/.*"))//拦截该路劲下的接口 .build() //创建
          .apiInfo(apiInfo()); //配置说明 } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("测试项目")//标题 .description("springboot整合swagger")//描述 .termsOfServiceUrl("http://www.baidu.com")// .contact(new Contact("wangx", "http://baidu.com","1028106567@qq.com"))//联系人 .version("1.0")//版本 .build(); } }

  这样就会拦截api路劲下的所有接口并生成document.

  访问:http://localhost:8080/swagger-ui.html#/

  视图如下:

  

  可以查看接口的相关信息,并且也可以不用通过postman就可以测试接口了。相当的便利的。

  同时swagger也提供了一些注解可以让我们使用在类或者方法上

  Swagger的注解及作用。 

  @Api:修饰整个类,描述Controller的作用
  @ApiOperation:描述一个类的一个方法,或者说一个接口
  @ApiParam:单个参数描述
  @ApiModel:用对象来接收参数
  @ApiProperty:用对象接收参数时,描述对象的一个字段
  @ApiResponse:HTTP响应其中1个描述
  @ApiResponses:HTTP响应整体描述
  @ApiIgnore:使用该注解忽略这个API
  @ApiError :发生错误返回的信息
  @ApiImplicitParam:一个请求参数
  @ApiImplicitParams:多个请求参数

原文 SpringBoot学习笔记(16)----SpringBoot整合Swagger2

转载于:https://www.cnblogs.com/xiaoshen666/p/10844089.html

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

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

相关文章

Jeff Dean亲自揭秘谷歌下一代AI架构:通用、稀疏且高效,网友不买帐:毫无新意...

来源&#xff1a;机器之心在这波 AI 浪潮中&#xff0c;人工智能技术经过十几年的爆发式发展&#xff0c;已经在各个领域有着极为广泛的应用&#xff0c;如医疗、科学研究、汽车等。但是随着技术发展的缓慢&#xff0c;以深度学习为代表的人工智能技术瓶颈开始凸显。今年 8 月份…

排序算法笔记(Java)

package datastructure;import java.util.Arrays; import java.util.Scanner;public class Sort {static int len; //声明全局变量&#xff0c;用于记录arr的长度public static void main(String[] args) {Scanner sc new Scanner(System.in);String str sc.nextLine();Strin…

计算机网络——时延、时延带宽积、RTT和利用率

1.什么是时延 \qquad数据&#xff08;报文/分组/比特流&#xff09;从网络的一端传送到网络另外一端所需的时间。也叫延迟或者迟延&#xff0c;单位是s 2.时延的种类 2.1 发送时延&#xff08;传输时延&#xff09; \qquad从发送分组的第一个比特算起&#xff0c;到该分组的最…

强人工智能与泛心论

来源&#xff1a;哲社院后台原载于《科学经济社会》2021年第39卷第3期第52~59页作者简介&#xff1a;陈敬坤&#xff0c;1981年1月生。哲学博士&#xff0c;山西大学哲学社会学学院副教授&#xff0c;曾赴比利时布鲁塞尔自由大学、美国匹兹堡大学等作学术访问。研究领域主要为心…

第一章 Linux是什么

Linux是核心与系统调用接口两层中间的操作系统不同硬件的功能函数并不相同&#xff0c;IBM的Power CPU与Inter的x86架构不同&#xff0c;所以同一套操作系统是不能在不同的硬件平台上面运行的。也就是说&#xff0c;每种操作系统都是在他专门的硬件机器上面运行的。不过&#x…

计算机网络——分层结构,协议,接口和服务

1.为什么要分层&#xff1f; \qquad当有两台主机&#xff0c;A向B通过网络发送文件&#xff0c;在发送文件前需要完成这么几件事情&#xff1a;1&#xff09;A必须将数据通信的通路进行激活&#xff1b;2&#xff09;要告诉网络如何识别目的主机B&#xff1b;3&#xff09;A要查…

官宣!全球首富马斯克:创办这所“新大学”!

埃隆马斯克&#xff08;Elon Musk&#xff09;是特斯拉和SpaceX的创始人兼首席执行官。来源&#xff1a;青塔编辑&#xff1a;nhyilin美国《福布斯》杂志10月26日称&#xff0c;得益于特斯拉股价大涨&#xff0c;特斯拉CEO埃隆马斯克的财富跃升至近3000亿美元&#xff0c;不仅是…

“传统”遥感遇上AI,会产生怎样的效果?

来源&#xff1a;微信公众号人民网责编&#xff1a;翟巧红编辑&#xff1a;张素玲&#xff1b;作者&#xff1a;龚健雅 中国科学院院士、武汉大学教授&#xff1b;新一轮科技革命和产业变革的大幕早已掀开。作为全球科技竞争的制高点&#xff0c;人工智能已经成为世界主要国家推…

记录一次双系统安装

条件 1、U盘 2、UltraISO软件 官网 3、ISO镜像 ubuntu官网 压缩卷&#xff0c;获得空闲空间安装ubuntu 1、点击winx&#xff0c;进入磁盘管理&#xff0c;选择一个空间够大的硬盘进行分区 2、选择你要压缩的卷&#xff0c;比如D盘&#xff0c;右击&#xff0c;压缩卷&#xff0…

操作系统 —— 内存管理

目录一、思维导图二、内存的基础知识2.1 什么是内存&#xff1f;2.2 存储单元2.3 逻辑地址和物理地址2.4 编译、链接、装入2.4.1 编译2.4.2 链接链接的三种方式 :2.4.3 装入装入的三种方式:三、内存保护四、内存空间的扩充4.1 覆盖与交换4.1.1 覆盖技术4.1.2 交换技术4.2 虚拟内…

【前沿技术】10年内,19个关键技术将改变世界

来源&#xff1a;智能研究院据国外媒体报道&#xff0c;从无人驾驶汽车到机器人工人&#xff0c;在我们熟悉所有这一切之前&#xff0c;未来正迎面走来。根据世界经济论坛全球议程理事会关于《未来软件与社会》的一份报告&#xff0c;到2025年前&#xff0c;很多新兴技术将会达…

计算机网络——TCP/IP参考模型和五层参考模型

1.OSI参考模型和TCP/IP参考模型的对比 \qquad相同点&#xff1a;1)都分层&#xff1b;2&#xff09;都是基于独立的协议栈的概念 &#xff1b;3&#xff09;可以实现异构网络的互联 \qquad不同点&#xff1a;1&#xff09;OSI定义了三点&#xff1a;服务&#xff0c;协议和接口…

Github+docsify打造在线文档网站

写在前面 搭建这个在线文档的目的是方便自己对学习笔记的查看&#xff0c;比较喜欢 docsify 的主题风格&#xff0c;所以没有用 Github Pages 直接给的主题&#xff0c;自己根据官方文档进行了配置&#xff0c;目前已经成功上线。 1 效果图 可直接访问&#xff1a;https://x…

计算机网络——物理层基本概念

1.物理层的任务 \qquad将各种计算机的传输媒体进行物理连接&#xff0c;为设备间的数据传输做好准备。由此&#xff0c;我们需要确定传输媒体的接口特性。 2.传输媒体的接口特性 2.1 机械特性 \qquad定义物理连接的特性&#xff0c;比如连接规格&#xff0c;接口形状&#xf…

《Cell》新发现!“第二大脑”的反击

图像:巨噬细胞(绿色)包围肠道神经元(红色)。资料来源:洛克菲勒大学黏膜免疫学实验室来源&#xff1a;生物通一个简单的胃病就能造成很大的伤害。有1亿个神经元散布在胃肠道中——就在火线上——它们可能被肠道感染消灭&#xff0c;可能导致长期的胃肠道疾病。但肠道感染也有好处…

操作系统 —— 文件管理

目录1. 文件的简介1.1. 文件的属性1.2. 文件的分类1.2.1. 无结构文件&#xff08;流式文件&#xff09;1.2.2. 有结构文件&#xff08;记录式文件&#xff09;1.3 操作系统应向上提供哪些功能2. 文件的逻辑结构2.1 逻辑结构 vs 物理结构2.2 有结构文件的逻辑结构2.2.1 顺序文件…

vue-todolist

http://todolist.cn/ App.vue <template><div><div>大家好&#xff0c;我叫技术高超</div><div>大家好&#xff0c;我叫{{name}}</div><input type"text" v-model"name"><hr><input type"text&qu…

重磅!监管再升级!微信、淘宝、抖音或将纳入“超级平台”监管

来源&#xff1a;网易新闻&#xff1a;中国证券报编辑&#xff1a;郑雅烁对于互联网巨头监管&#xff0c;又有新举措。10月29日&#xff0c;国家市场监督管理总局公布了《互联网平台分类分级指南&#xff08;征求意见稿&#xff09;》《互联网平台落实主体责任指南&#xff08;…

linux的基础知识——raise函数,abort函数和定时函数

1.raise和abort函数 \qquadraise函数&#xff1a;int raise(int sig) \qquad功能&#xff1a;给当前进程发送指定信号&#xff08;自己给自己发信号&#xff09;&#xff0c;raise(signo)相当于kill(getpid(),signo) \qquad返回值&#xff1a;成功返回0&#xff1b;失败返回非0…

操作系统 —— 磁盘

目录1. 磁盘的结构1.1. 磁盘、磁道、扇区1.2. 如何在磁盘中读/写数据1.3. 盘面、柱面1.4. 磁盘的物理地址1.5. 磁盘的分类2. 磁盘调度算法一次磁盘读/写操作需要的时间2.1. 先来先服务算法&#xff08;FCFS&#xff09;2.2. 最短寻找时间优先&#xff08;SSTF&#xff09;2.3. …