1导入依赖
<!--swagger 依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<!--swagger ui 依赖,使界面展示规范-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
2编写swaggerconfig配置文件
package com.platform.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
*
* @gitee https://gitee.com/fuyang_lipengjun/platform
*/
@Configuration
@EnableWebMvc
@EnableSwagger2
@ComponentScan(basePackages="com.platform.api")
public class SwaggerConfig {
/*
这个方法的返回值交给Spring 管理
*/
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(this.apiInfo())
.select()
//哪些包需要生成文档
.apis(RequestHandlerSelectors.basePackage("com.platform.api"))
.paths(PathSelectors.any())
.build();
}
/**
* 该套 API 说明,包含作者、简介、版本、host、服务URL
* @return
*/
private ApiInfo apiInfo(){
@SuppressWarnings("deprecation")
ApiInfo info=new ApiInfo(
"小程序接口文档",
"小程序接口文档",
"1.0",
"urn:tos",
"platform",
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0");
return info;
}
}
4swagger配置文件常用方法
地址:https://www.cnblogs.com/mao2080/p/9021714.html
3使用swagger提供的注解
地址: https://blog.csdn.net/fansunion/article/details/51923720
4在ioc容器注册swaggerconfig
//添加configuration配置类,自动创建bean,不需要写xml
@Configuration
5swaggerui