Spring Boot 学习(12)springboot 整合 swagger2
程序员文章站
2022-07-02 20:30:57
...
文章目录
写在前面:最近利用晚上的时间在网上看视频学习Spring Boot,这博客是对学习的一点点总结及记录,技术是开源的、知识是共享的。
如果你对Spring Boot 感兴趣,可以关注我的动态,我们一起学习。用知识改变命运,让家人过上更好的生活。
一、Swagger2 介绍
1. Swagger2 出现的背景
现如今,前后端分离已经逐渐成为互联网项目一种标准的开发方式,前端与后端交给不同的人员开发,但是项目开发中的沟通成本也随之升高,这部分沟通成本主要在于前端开发人员与后端开发人员对WebAPI接口的沟通,Swagger2 就可以很好地解决,它可以动态生成Api接口文档,降低沟通成本,促进项目高效开发。
2. 什么是 Swagger2
Swagger2 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
3. Swagger 的特点
- 及时性 (接口变更后,能够及时准确地通知相关前后端开发人员)
- 规范性 (并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
- 一致性 (接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
- 可测性 (直接在接口文档上进行测试,以方便理解业务)
二、springboot 整合 swagger2
1、在pom中添加依赖
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
2、创建Swagger2配置文件
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket webApiConfig() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.build();
}
private ApiInfo webApiInfo() {
return new ApiInfoBuilder()
.title("网站-扬帆向海的博客文档")
.description("本文档描述了博客中心微服务接口定义")
.version("1.0")
.contact(new Contact("扬帆向海", "http://zhangxy.com", "aaa@qq.com"))
.build();
}
}
3、重启服务器查看接口
http://localhost:8101/swagger-ui.html
具体里面的内容以及接口测试,这里就不一一展示了。
上一篇: 文件压缩 ——— Huffman
下一篇: 项目解析-affnet项目
推荐阅读
-
Spring Boot入门系列八(SpringBoot 整合Mybatis)
-
十、Spring boot 简单优雅的整合 Swagger2
-
轻轻松松学习SpringBoot2:第二十五篇: Spring Boot和Mongodb整合(完整版)
-
SpringBoot整合rabbitMQ,spring-boot-starter-amqp 的使用
-
荐 springboot整合swagger2以及swagger2的介绍与Spring Security的整合使用
-
shiro学习三(spring boot整合shiro读取数据库数据实现用户登录,权限认证)
-
Spring Boot整合Swagger2
-
Spring Boot整合swagger2
-
07 Spring Boot整合 Swagger2
-
Spring Boot整合Swagger2