关于Swagger
Swagger API在线文档是连接前后台开发的一座桥梁,也是后台开发工程师测试接口的强大工具之一,在Restful软件架构风格中,几乎每个项目都集成了Swagger,还记得之前没用 Swagger的时候,测试接口都要跑PostMan,Get请求还好,参数不算多,遇到表单提交 的POST或者PUT请求的时候,那是一个劲的头疼,所以今天博主分享一下在Spring Boot项目中集成Swagger。具体介绍就不多说,可到官网查看官网地址
SpringBoot集成Swagger
1. 使用IDEA新建Spring Boot项目
选择 File->new Project-> Spring Initializr
2.默认选项,如需修改可自行修改
3.勾选Web->Spring Web
4.在pom.xml文件中添加以下依赖
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
5.添加Swagger配置,新建Swagger配置类文件SwaggerConfig*
package com.example.config;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RequestMapping;
import springfox.documentation.RequestHandler;
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
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//文档标题
.title(" Spring Boot RESTful API")
// 版本号
.version("1.0")
// 标题描述
.description("swagger在线文档")
.build();
}
}
6.到这里我们的Spring Boot集成Swagger配置就大功告成了,来看一下效果
下一篇博客继续为小伙伴分享一下如何使用Swagger自动生成接口文档!