从零开始的SpringBoot项目 ( 五 ) 整合 Swagger 实现在线API文档的功能

综合概述

spring-boot作为当前最为流行的Java web开发脚手架，越来越多的开发者选择用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端（b/s），也会服务于移动端。在实际开发过程中，这些接口还要提供给开发测试进行相关的白盒测试，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。

假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝，那么尝试一下Swagger2 方式，一定会让你有不一样的开发体验。

使用 Swagger 集成文档具有以下几个优势：

功能丰富：支持多种注解，自动生成接口文档界面，支持在界面测试API接口功能；
及时更新：开发过程中花一点写注释的时间，就可以及时的更新API文档，省心省力；
整合简单：通过添加pom依赖和简单配置，内嵌于应用中就可同时发布API接口文档界面，不需要部署独立服务。

创建一个SpringBoot项目

从零开始的SpringBoot项目 ( 二 ) 使用IDEA创建一个SpringBoot项目

添加相关依赖

 1 <!-- Swagger -->
 2     <dependency>
 3       <groupId>io.springfox</groupId>
 4       <artifactId>springfox-swagger2</artifactId>
 5       <version>2.4.0</version>
 6     </dependency>
 7     <!-- SwaggerUI -->
 8     <dependency>
 9       <groupId>io.springfox</groupId>
10       <artifactId>springfox-swagger-ui</artifactId>
11       <version>2.4.0</version>
12     </dependency>

添加配置类 SwaggerConfig

 1 package com.my_springboot.config;
 2 
 3 import io.swagger.annotations.ApiOperation;
 4 import java.util.ArrayList;
 5 import java.util.List;
 6 import org.springframework.context.annotation.Bean;
 7 import org.springframework.context.annotation.Configuration;
 8 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 9 import springfox.documentation.builders.ApiInfoBuilder;
10 import springfox.documentation.builders.ParameterBuilder;
11 import springfox.documentation.builders.PathSelectors;
12 import springfox.documentation.builders.RequestHandlerSelectors;
13 import springfox.documentation.schema.ModelRef;
14 import springfox.documentation.service.ApiInfo;
15 import springfox.documentation.service.Contact;
16 import springfox.documentation.service.Parameter;
17 import springfox.documentation.spi.DocumentationType;
18 import springfox.documentation.spring.web.plugins.Docket;
19 import springfox.documentation.swagger2.annotations.EnableSwagger2;
20 
21 /**
22  * Swagger2配置类
23  */
24 @Configuration
25 @EnableSwagger2
26 public class SwaggerConfig implements WebMvcConfigurer {
27 
28     @Bean
29     public Docket createRestApi() {
30 
31         return new Docket(DocumentationType.SWAGGER_2)
32                 .apiInfo(apiInfo())
33                 .select()
34                 // 加了ApiOperation注解的类，才会生成接口文档
35                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
36                 // 指定包下的类，才生成接口文档
37                 //.apis(RequestHandlerSelectors.basePackage("com.my_springboot.user.controller"))
38                 .paths(PathSelectors.any())
39                 .build();
40     }
41 
42     private ApiInfo apiInfo() {
43         //访问地址：http://localhost:8080/swagger-ui.html#/
44         return new ApiInfoBuilder()
45                 .title("my_springboot后端api接口文档")// 设置页面标题
46                 .description("欢迎访问my_springboot接口文档，本文档描述了my_springboot后端相关接口的定义")// 描述
47                 .termsOfServiceUrl("https://服务条款.com/")// 服务条款
48                 .contact(new Contact("联系人", null, null))// 设置联系人
49                 .version("1.0.0")// 定义版本号
50                 .build();
51     }
52 
53 }

添加控制器 HellowController

 1 package com.my_springboot.controller;
 2 
 3 import org.springframework.web.bind.annotation.GetMapping;
 4 import org.springframework.web.bind.annotation.RequestParam;
 5 import org.springframework.web.bind.annotation.RestController;
 6 
 7 import io.swagger.annotations.Api;
 8 import io.swagger.annotations.ApiOperation;
 9 import io.swagger.annotations.ApiParam;
10 
11 /* 类注解 */
12 @Api(value = "desc of class")
13 @RestController
14 public class HelloController {
15 
16     /* 方法注解 */
17     @ApiOperation(value = "desc of method", notes = "")
18     @GetMapping(value="/hello")
19     public Object hello( /* 参数注解 */ @ApiParam(value = "desc of param" , required=true ) @RequestParam String name) {
20         return "Hello " + name + "!";
21     }
22 }

启动项目并访问浏览器

常用注解说明

swagger 通过注解接口生成文档，包括接口名，请求方法，参数，返回信息等。

@Api: 修饰整个类，用于controller类上

@ApiOperation: 描述一个接口，用户controller方法上

@ApiParam: 单个参数描述

@ApiModel: 用来对象接收参数,即返回对象

@ApiModelProperty: 对象接收参数时，描述对象的字段

@ApiResponse: Http响应其中的描述，在ApiResonse中

@ApiResponses: Http响应所有的描述，用在

@ApiIgnore: 忽略这个API

@ApiError: 发生错误的返回信息

@ApiImplicitParam: 一个请求参数

@ApiImplicitParam: 多个请求参数

更多使用说明，参考 Swagger 使用手册。

添加请求参数

在很多时候，我们需要在调用我们每一个接口的时候都携带上一些通用参数，比如采取token验证逻辑的往往在接口请求时需要把token也一起传入后台，接下来，我们就来讲解一下如何给Swagger添加固定的请求参数。

修改SwaggerConfig配置类，替换成如下内容，利用ParameterBuilder构成请求参数。

 1 package com.my_springboot.config;
 2 
 3 import io.swagger.annotations.ApiOperation;
 4 import java.util.ArrayList;
 5 import java.util.List;
 6 import org.springframework.context.annotation.Bean;
 7 import org.springframework.context.annotation.Configuration;
 8 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 9 import springfox.documentation.builders.ApiInfoBuilder;
10 import springfox.documentation.builders.ParameterBuilder;
11 import springfox.documentation.builders.PathSelectors;
12 import springfox.documentation.builders.RequestHandlerSelectors;
13 import springfox.documentation.schema.ModelRef;
14 import springfox.documentation.service.ApiInfo;
15 import springfox.documentation.service.Contact;
16 import springfox.documentation.service.Parameter;
17 import springfox.documentation.spi.DocumentationType;
18 import springfox.documentation.spring.web.plugins.Docket;
19 import springfox.documentation.swagger2.annotations.EnableSwagger2;
20 
21 /**
22  * Swagger2配置类
23  */
24 @Configuration
25 @EnableSwagger2
26 public class SwaggerConfig implements WebMvcConfigurer {
27 
28     @Bean
29     public Docket createRestApi() {
30 
31         // 为swagger添加header参数可供输入
32         ParameterBuilder userTokenHeader = new ParameterBuilder();
33         userTokenHeader.name("token").description("令牌")
34                 .modelRef(new ModelRef("string")).parameterType("header")
35                 .required(false).build();
36         List<Parameter> pars = new ArrayList<Parameter>();
37         pars.add(userTokenHeader.build());
38         return new Docket(DocumentationType.SWAGGER_2)
39                 .apiInfo(apiInfo())
40                 .select()
41                 // 加了ApiOperation注解的类，才会生成接口文档
42                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
43                 // 指定包下的类，才生成接口文档
44                 //.apis(RequestHandlerSelectors.basePackage("com.my_springboot.user.controller"))
45                 .paths(PathSelectors.any())
46                 .build()
47                 .globalOperationParameters(pars);
48     }
49 
50     private ApiInfo apiInfo() {
51         //访问地址：http://localhost:8088/xin_mei_love/swagger-ui.html#!
52         return new ApiInfoBuilder()
53                 .title("my_springboot后端api接口文档")// 设置页面标题
54                 .description("欢迎访问my_springboot接口文档，本文档描述了my_springboot后端相关接口的定义")// 描述
55                 .termsOfServiceUrl("https://服务条款.com/")// 服务条款
56                 .contact(new Contact("联系人", null, null))// 设置联系人
57                 .version("1.0.0")// 定义版本号
58                 .build();
59     }
60 
61 }

完成之后重新启动应用，再次查看hello接口，可以看到已经支持发送token请求参数了。

posted on 2020-08-21 15:26 法哈席基阅读(514) 评论(0) 编辑收藏举报