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

2022-12-05 18:36:49

综合概述

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

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

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

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

创建一个SpringBoot项目

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

添加相关依赖

 <!-- Swagger -->

     <dependency>

       <groupId>io.springfox</groupId>

       <artifactId>springfox-swagger2</artifactId>

       <version>2.4.0</version>

     </dependency>

     <!-- SwaggerUI -->

     <dependency>

       <groupId>io.springfox</groupId>

       <artifactId>springfox-swagger-ui</artifactId>

       <version>2.4.0</version>

     </dependency>

添加配置类 SwaggerConfig

 package com.my_springboot.config;

 import io.swagger.annotations.ApiOperation;

 import java.util.ArrayList;

 import java.util.List;

 import org.springframework.context.annotation.Bean;

 import org.springframework.context.annotation.Configuration;

 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

 import springfox.documentation.builders.ApiInfoBuilder;

 import springfox.documentation.builders.ParameterBuilder;

 import springfox.documentation.builders.PathSelectors;

 import springfox.documentation.builders.RequestHandlerSelectors;

 import springfox.documentation.schema.ModelRef;

 import springfox.documentation.service.ApiInfo;

 import springfox.documentation.service.Contact;

 import springfox.documentation.service.Parameter;

 import springfox.documentation.spi.DocumentationType;

 import springfox.documentation.spring.web.plugins.Docket;

 import springfox.documentation.swagger2.annotations.EnableSwagger2;

 /**

  * Swagger2配置类

  */

 @Configuration

 @EnableSwagger2

 public class SwaggerConfig implements WebMvcConfigurer {

     @Bean

     public Docket createRestApi() {

         return new Docket(DocumentationType.SWAGGER_2)

                 .apiInfo(apiInfo())

                 .select()

                 // 加了ApiOperation注解的类，才会生成接口文档

                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

                 // 指定包下的类，才生成接口文档

                 //.apis(RequestHandlerSelectors.basePackage("com.my_springboot.user.controller"))

                 .paths(PathSelectors.any())

                 .build();

     }

     private ApiInfo apiInfo() {

         //访问地址：http://localhost:8080/swagger-ui.html#/

         return new ApiInfoBuilder()

                 .title("my_springboot后端api接口文档")// 设置页面标题

                 .description("欢迎访问my_springboot接口文档，本文档描述了my_springboot后端相关接口的定义")// 描述

                 .termsOfServiceUrl("https://服务条款.com/")// 服务条款

                 .contact(new Contact("联系人", null, null))// 设置联系人

                 .version("1.0.0")// 定义版本号

                 .build();

     }

 }

添加控制器 HellowController

 package com.my_springboot.controller;

 import org.springframework.web.bind.annotation.GetMapping;

 import org.springframework.web.bind.annotation.RequestParam;

 import org.springframework.web.bind.annotation.RestController;

 import io.swagger.annotations.Api;

 import io.swagger.annotations.ApiOperation;

 import io.swagger.annotations.ApiParam;

 /* 类注解 */

 @Api(value = "desc of class")

 @RestController

 public class HelloController {

     /* 方法注解 */

     @ApiOperation(value = "desc of method", notes = "")

     @GetMapping(value="/hello")

     public Object hello( /* 参数注解 */ @ApiParam(value = "desc of param" , required=true ) @RequestParam String name) {

         return "Hello " + name + "!";

     }

 }

启动项目并访问浏览器

常用注解说明

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

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

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

@ApiParam: 单个参数描述

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

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

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

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

@ApiIgnore: 忽略这个API

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

@ApiImplicitParam: 一个请求参数

@ApiImplicitParam: 多个请求参数

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

添加请求参数

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

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

 package com.my_springboot.config;

 import io.swagger.annotations.ApiOperation;

 import java.util.ArrayList;

 import java.util.List;

 import org.springframework.context.annotation.Bean;

 import org.springframework.context.annotation.Configuration;

 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

 import springfox.documentation.builders.ApiInfoBuilder;

 import springfox.documentation.builders.ParameterBuilder;

 import springfox.documentation.builders.PathSelectors;

 import springfox.documentation.builders.RequestHandlerSelectors;

 import springfox.documentation.schema.ModelRef;

 import springfox.documentation.service.ApiInfo;

 import springfox.documentation.service.Contact;

 import springfox.documentation.service.Parameter;

 import springfox.documentation.spi.DocumentationType;

 import springfox.documentation.spring.web.plugins.Docket;

 import springfox.documentation.swagger2.annotations.EnableSwagger2;

 /**

  * Swagger2配置类

  */

 @Configuration

 @EnableSwagger2

 public class SwaggerConfig implements WebMvcConfigurer {

     @Bean

     public Docket createRestApi() {

         // 为swagger添加header参数可供输入

         ParameterBuilder userTokenHeader = new ParameterBuilder();

         userTokenHeader.name("token").description("令牌")

                 .modelRef(new ModelRef("string")).parameterType("header")

                 .required(false).build();

         List<Parameter> pars = new ArrayList<Parameter>();

         pars.add(userTokenHeader.build());

         return new Docket(DocumentationType.SWAGGER_2)

                 .apiInfo(apiInfo())

                 .select()

                 // 加了ApiOperation注解的类，才会生成接口文档

                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

                 // 指定包下的类，才生成接口文档

                 //.apis(RequestHandlerSelectors.basePackage("com.my_springboot.user.controller"))

                 .paths(PathSelectors.any())

                 .build()

                 .globalOperationParameters(pars);

     }

     private ApiInfo apiInfo() {

         //访问地址：http://localhost:8088/xin_mei_love/swagger-ui.html#!

         return new ApiInfoBuilder()

                 .title("my_springboot后端api接口文档")// 设置页面标题

                 .description("欢迎访问my_springboot接口文档，本文档描述了my_springboot后端相关接口的定义")// 描述

                 .termsOfServiceUrl("https://服务条款.com/")// 服务条款

                 .contact(new Contact("联系人", null, null))// 设置联系人

                 .version("1.0.0")// 定义版本号

                 .build();

     }

 }

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

码农公寓