Swagger——【SpringBoot集成Swagger、配置Swagger、配置扫描接口、配置API分组】

二、SpringBoot集成Swagger

三、配置Swagger

四、配置扫描接口

五、配置Swagger开关

六、配置API分组

七、实体配置

八、总结:

---

一、swagge简介

==========

前后端分离:

后端︰后端控制层，服务层，数据访问层【后端团队】

前端:前端控制层，视图层【前端团队】

前后端通过API进行交互

前后端相对独立且松耦合

产生问题：前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方法：首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

前后端分离：       前端测试后端接口:postman

后端提供接口，需要实时更新最新的消息及改动!

Swagger

• 号称世界上最流行的API框架

• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

• 直接运行，在线测试API

• 支持多种语言 （如：Java，PHP等）

• 官网：API Documentation & Design Tools for Teams | Swagger

二、SpringBoot集成Swagger

=====================

1、新建一个SpringBoot-web项目

2、添加Maven依赖

io.springfox

springfox-swagger2

2.9.2

io.springfox

springfox-swagger-ui

2.9.2

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration

@EnableSwagger2 //开启Swagger2

public class SwaggerConfig {

}

5.访问测试 ：http://localhost:8081/swagger-ui.html,可以看到swagger的界面；

三、配置Swagger

============

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

//配置了Swagger的Docket的bean实例

@Bean

public Docket docket(){

return new Docket(DocumentationType.SWAGGER_2);

}

2、可以通过apiInfo()属性配置文档信息

//配置文档信息

private ApiInfo apiInfo() {

Contact contact = new Contact(“龍弟”, “https://blog.csdn.net/weixin_48838340”, “联系人邮箱”);

return new ApiInfo(

“龍弟的Swagger学习文档”, // 标题

“学习演示如何配置Swagger”, // 描述

“v1.0”, // 版本

“https://blog.csdn.net/weixin_48838340”, // 组织链接

contact, // 联系人信息

“Apach 2.0 许可”, // 许可

“许可链接”, // 许可连接

new ArrayList<>()// 扩展

);

}

}

3、Docket 实例关联上 apiInfo()

@Bean

public Docket docket(){

return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());

}

4.重启项目

四、配置扫描接口

=========

构建Docket时通过select()方法配置怎么扫描接口。

//配置了Swagger的Docket的bean实例

@Bean

public Docket docket(){

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口

//any() // 扫描所有，项目中的所有接口都会被扫描到

// none() // 不扫描接口

// withMethodAnnotation通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求

// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口

.apis(RequestHandlerSelectors.basePackage(“com.longdi.swagger.controller”))

//path() 过滤什么路径

.paths(PathSelectors.ant(“/longdi/**”))

.build();

};

五、配置Swagger开关

=============

1、通过enable()方法配置是否启用swagger

@Bean

public Docket docket() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问

.select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口

.apis(RequestHandlerSelectors.basePackage(“com.longdi.swagger.controller”))

// 配置如何通过path过滤,即这里只扫描请求以/longdi开头的接口

.paths(PathSelectors.ant(“/longdi/**”))

.build();

}

2.如何动态配置当项目处于test、dev环境时显示swagger

@Bean

public Docket docket(Environment environment) {

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
-O2HwMHCZ-1715098928537)]

[外链图片转存中…(img-W2a4VmYV-1715098928537)]

[外链图片转存中…(img-7HWO2Dyk-1715098928537)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！