程序猿最烦两件事，第一件事是别人要他给自己的代码写文档，第二件呢？是别人的程序没有留下文档。

程序员最讨厌的四件事：写注释、写文档、别人不写注释、别人不写文档……

关于写文档这个事情，争论已久，今天就介绍一个解决这个问题的东东，Swagger。
这里介绍的是由程序员 DD 翟永超提供的spring-boot-starter-swagger关于其详细设置在文章底部。

pom.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<!-- 引入swagger2 -->
		<dependency>
			<groupId>com.spring4all</groupId>
			<artifactId>swagger-spring-boot-starter</artifactId>
			<version>1.8.0.RELEASE</version>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

在这里我们需要做的事情就不像引入官方依赖一样需要一个个的加注解，只需要一个注解就 OK 了。@EnableSwagger2Doc，这个注解加在启动类上

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.priv.gabriel;

import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@EnableSwagger2Doc
@SpringBootApplication
public class Demoforswagger2Application {

	public static void main(String[] args) {
		SpringApplication.run(Demoforswagger2Application.class, args);
	}
}

输入http://localhost:8080/swagger-ui.html进行访问
image.png
打开UserController看一下
image.png
继续查看一个具体的请求
image.png
基本信息都有了，也可以在这里测试接口。

可以看到我们几乎没有怎么操作一个文档就建立完毕了。
spring-boot-starter-swagger 项目及文档
本项目的下载地址