Swagger

Posted 2021-10-28 杀手不太冷！

文章目录

• Swagger
• • Swagger简介
  • SpringBoot集成Swagger
  • Swagger配置扫描接口
  • • 加一个配置类
    • basePackage扫描指定包中的接口
    • any扫描全部的接口
  • 在微服务架构里面使用swagger显示微服务工程对外暴露的接口

Swagger

Swagger简介

Swagger可以用来自动显示项目中的所有的接口，什么是接口？前后端交互的时候，必须提供一个入口，这个入口就是一个接口，接口其实可以理解成是Controller控制器中的方法上面的@RequestMapping()注解里面写的路径值。
使用Swagger就可以显示出项目中的所有的@RequestMapping(…)里面的路径值，也即是可以显示出所有的接口。

SpringBoot集成Swagger

1.新建一个SpringBoot web项目

2.导入相关依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

3.编写一个hello工程

4.访问测试

链接：http://localhost:8080/swagger-ui.html

swagger-ui.html文件的位置，如下图：

Swagger配置扫描接口

加一个配置类

配置类内容如下图：

basePackage扫描指定包中的接口

any扫描全部的接口

在微服务架构里面使用swagger显示微服务工程对外暴露的接口

在工程中引入swagger依赖之后，启动工程，如下图：

启动工程之后，我们就可以在浏览器中通过swagger去查看该工程暴露到外边的所有的接口，如下图：

注意上图中的暴露的接口的上面有一个归类名字"绩效钉钉待办日程任务重试"，这个名字是怎么设置的呢？如下图：

对于微服务来说，它的暴露的接口，不像是我们之前学过的Controller控制器，是通过@RequestMapping注解里面的value值暴露的，对于微服务来说，它暴露的接口就是"/方法的名字/方法的参数"，如下图：