API接口文档利器Swagger

2.1.1 Swagger 介绍

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务

( https://swagger.io/ ) 。 它的主要作用是：

1. 使得前后端分离开发更加方便，有利于团队协作

2. 接口的文档在线自动生成，降低后端开发人员编写接口文档的负担

3. 功能测试

Spring 已经将 Swagger 纳入自身的标准，建立了 Spring-swagger 项目，现在叫 Springfox 。通过在项目中引入

Springfox ，即可非常简单快捷的使用 Swagger 。

2.1.2 SpringBoot 集成 Swagger

1. 在项目中添加依赖。

<!‐‐ Swagger依赖 ‐‐>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox‐swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox‐swagger‐ui</artifactId>
</dependency>

2. 在 工程的 config 包中添加一个 Swagger 配置类

 

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
@EnableSwagger2
public class SwaggerConfiguration {
@Bean
public Docket buildDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(buildApiInfo())
.select()
// 要扫描的API(Controller)基础包
.apis(RequestHandlerSelectors.basePackage("com.shanjupay.merchant.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* @param
* @return springfox.documentation.service.ApiInfo
* @Title: 构建API基本信息
* @Title: 构建API基本信息
* @methodName: buildApiInfo
*/
private ApiInfo buildApiInfo() {
Contact contact = new Contact("开发者","","");
return new ApiInfoBuilder()
.title("API文档")
.description("")
.contact(contact)
.version("1.0.0").build();
}
}

3. 添加SpringMVC配置类：WebMvcConfig，让外部可直接访问Swagger文档 

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Component
public class WebMvcConfig implements WebMvcConfigurer {
/**
* 添加静态资源文件，外部可以直接访问地址
*
* @param registry
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
registry.addResourceHandler("swagger‐ui.html")
.addResourceLocations("classpath:/META‐INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META‐INF/resources/webjars/");
}
}

2.1.3 Swagger 常用注解

在 Java 类中添加 Swagger 的注解即可生成 Swagger 接口文档，常用 Swagger 注解如下：

@Api ：修饰整个类，描述 Controller 的作用 @ApiOperation ：描述一个类的一个方法，或者说一个接口

@ApiParam ：单个参数的描述信息

@ApiModel ：用对象来接收参数

@ApiModelProperty ：用对象接收参数时，描述对象的一个字段

@ApiResponse ： HTTP 响应其中 1 个描述

@ApiResponses ： HTTP 响应整体描述

@ApiIgnore ：使用该注解忽略这个 API

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

@ApiImplicitParam ：一个请求参数

@ApiImplicitParams ：多个请求参数的描述信息

@ApiImplicitParam 属性：