高手的存在,就是让服务10亿人的时候,你感觉只是为你一个人服务......

iBase4J 源码之Swagger2接口管理

目录
  1. 1. 添加Swagger2依赖
  2. 2. 创建Swagger2配置类。
  3. 3. 配置Controller中的API
  4. 4. API文档访问与测试

The Best APIs are Built with Swagger Tools.

by https://swagger.io/


Swagger2 作为RESTful API的好伙伴, 很容易与spring boot整合在一起,并组织成一套RESTful API文档。开发人员修改了接口,接口文档会自动更新,Swagger2同时为开发人员提供了强大的接口测试功能,省去了很多测试代码的编写工作。

iBase4J 中使用Swagger2 来进行接口管理,项目启动后访问http://localhost:8088/swagger-ui.html ,可以看到接口管理页面。

Alt text


下面咱们结合iBase4J源码来介绍,如何在Spring Boot中使用Swagger2。

添加Swagger2依赖

在pom.xml中加入Swagger2的依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox.version}</version>
</dependency>

<properties> <springfox.version>2.7.0</springfox.version>
</properties>

创建Swagger2配置类。

iBase4J提供了SwaggerConfig.java进行Swagger2配置。

Alt text

@EnableSwagger2 用于开启swagger2配置。

apiInfo() 用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。


配置Controller中的API

iBase4J-SYS-Web项目和iBase4J-Biz-Web项目中的RestFull API都使用iBase4J进行接口管理,这里看一个LoginController的例子。

Alt text

需要关注的注解:参考

1
2
3
4
5
@Api:标记一个Controller类做为swagger。

@ApiOperation:注解在方法上,描述接口操作。

@ApiParam:请求参数的描述。

API文档访问与测试

http://localhost:8088/swagger-ui.html#/ —看到接口列表

Alt text

输入请求入参,点击Try it out即可进行接口测试。

Alt text