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

时间:2024-10-12 14:57:46

二、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依赖

springfox-swagger2

2.9.2

springfox-swagger-ui

2.9.2

3、编写HelloController,测试确保运行成功!

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

@Configuration

@EnableSwagger2 //开启Swagger2

public class SwaggerConfig {

}

5.访问测试 :http://localhost:8081/,可以看到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(“龍弟”, “/weixin_48838340”, “联系人邮箱”);

return new ApiInfo(

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

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

“v1.0”, // 版本

“/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()只扫描get请求

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

.apis((“”))

//path() 过滤什么路径

.paths((“/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((“”))

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

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

.build();

}

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

@Bean

public Docket docket(Environment environment) {

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

深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

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

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!

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

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)

img

总结

互联网大厂比较喜欢的人才特点:对技术有热情,强硬的技术基础实力;主动,善于团队协作,善于总结思考。无论是哪家公司,都很重视高并发高可用技术,重视基础,所以千万别小看任何知识。面试是一个双向选择的过程,不要抱着畏惧的心态去面试,不利于自己的发挥。同时看中的应该不止薪资,还要看你是不是真的喜欢这家公司,是不是能真的得到锻炼。其实我写了这么多,只是我自己的总结,并不一定适用于所有人,相信经过一些面试,大家都会有这些感触。

**另外本人还整理收藏了2021年多家公司面试知识点以及各种技术点整理 **

下面有部分截图希望能对大家有所帮助。

在这里插入图片描述
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
团队协作,善于总结思考。无论是哪家公司,都很重视高并发高可用技术,重视基础,所以千万别小看任何知识。面试是一个双向选择的过程,不要抱着畏惧的心态去面试,不利于自己的发挥。同时看中的应该不止薪资,还要看你是不是真的喜欢这家公司,是不是能真的得到锻炼。其实我写了这么多,只是我自己的总结,并不一定适用于所有人,相信经过一些面试,大家都会有这些感触。

**另外本人还整理收藏了2021年多家公司面试知识点以及各种技术点整理 **

下面有部分截图希望能对大家有所帮助。

[外链图片转存中…(img-2JsNBNFQ-1713343887979)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!