Swagger在线接口文档

Swagger在线接口文档

一、介绍

使用Swagger你只需要按照它的规范去定义接口及接口相关信息，就可以做到生成接口文档，以及在线接口调试页面。
Swagger官网

直接使用Swagger是比较繁琐的，推荐使用Knife4j框架，它对Swagger进行了封装，简化了相应的操作。

knife4j是为Java Mvc框架集成Swagger生成Api文档的增强解决方案

二、使用方式

1.导入knife4j的maven坐标

<dependency>
		<groupId>com.github.xiaoymin</groupId>
		<artifactId>knife4j-spring-boot-starter</artifactId>
		<version>3.0.2</version>
</dependency>
<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2.在配置类中加入knife4j相关配置

@Bean
public Docket docket(){
	ApiInfo apiInfo = new ApiInfoBuilder()
		.title("Swagger在线接口文档")//需要改成自己接口文档的名字
		.version("2.0")//版本号
		.description("Swagger在线接口文档")//描述信息
		.build();
		
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("com.sky.controller"))//指定生成接口需要扫描的包
.paths(PathSelectors.any())
.build();
return docket;
}

3.设置静态资源映射，否则接口文档页面无法访问

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
log.info("开始设置静态资源映射...");
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/";

三、常用注解

注解	说明
@Api	用在类上，例如Controller，表示对类的说明
@ApiModel	用在类上，例如entity、DTO、VO
@ApiModelPropoerty	用在属性上，描述属性信息
@ApiOperation	用在方法上，例如Controller的方法，说明方法的用途、作用

四、使用方法

直接访问http://localhost:8080/doc.html
注意：这里的8080是我自己后端的端口号，不一样的需要改成自己的端口号