使用Restdocs创建API文档

本指南将引导您完成在Spring应用程序中为HTTP端点生成文档的过程。

你会建立什么

您将使用一些暴露API的HTTP端点构建一个简单的Spring应用程序。您将使用JUnit和Spring的仅测试Web层MockMvc。然后，您将通过Spring REST Docs使用相同的测试为API生成文档。

你需要什么

约15分钟
最喜欢的文本编辑器或IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还可以将代码直接导入到IDE中：
- 弹簧工具套件（STS）
- IntelliJ IDEA

如何完成本指南

像大多数Spring入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用代码。

要从头开始，请继续进行“从Spring Initializr开始”。

要跳过基础知识，请执行以下操作：

下载并解压缩本指南的源存储库，或使用Git对其进行克隆：git clone https://github.com/spring-guides/gs-testing-restdocs.git
光盘进入 gs-testing-restdocs/initial
继续创建一个简单的应用程序。

完成后，您可以根据中的代码检查结果gs-testing-restdocs/complete。

从Spring Initializr开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Web）。

以下清单显示了pom.xml选择Maven时创建的文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.4.4</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>testing-restdocs</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>testing-restdocs</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

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

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

如果使用Gradle，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Web）。

以下清单显示了build.gradle选择Gradle时创建的文件：

plugins {
	id 'org.springframework.boot' version '2.4.4'
	id 'io.spring.dependency-management' version '1.0.11.RELEASE'
	id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	testImplementation('org.springframework.boot:spring-boot-starter-test')
}

test {
	useJUnitPlatform()
}

手动初始化（可选）

如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：

导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。
单击Dependencies，然后选择Spring Web。
点击生成。
下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。

如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。

创建一个简单的应用程序

为您的Spring应用程序创建一个新的控制器。以下清单（来自src/main/java/com/example/testingrestdocs/HomeController.java）显示了如何执行此操作：

package com.example.testingrestdocs;

import java.util.Collections;
import java.util.Map;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HomeController {

	@GetMapping("/")
	public Map<String, Object> greeting() {
		return Collections.singletonMap("message", "Hello, World");
	}

}

运行应用程序

Spring Initializr创建一个main可用于启动应用程序的类。以下清单（来自src/main/java/com/example/testingrestdocs/TestingRestdocsApplication.java）显示了Spring Initializr创建的应用程序类：

package com.example.testingrestdocs;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class TestingRestdocsApplication {

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

@SpringBootApplication 是一个方便注释，它添加了以下所有内容：

@Configuration：将类标记为应用程序上下文的Bean定义的源。
@EnableAutoConfiguration：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。
@EnableWebMvc：将应用程序标记为Web应用程序并激活关键行为，例如设置DispatcherServlet。Spring Bootspring-webmvc在类路径上看到它时会自动添加它。
@ComponentScan：告诉Spring在包中寻找其他组件，配置和服务com.example.testingrestdocs，让它找到HelloController类。

该main()方法使用Spring Boot的SpringApplication.run()方法来启动应用程序。您是否注意到没有一行XML？也没有web.xml文件。该Web应用程序是100％纯Java，因此您无需处理任何管道或基础结构。Spring Boot会为您处理所有这一切。

显示日志记录输出。该服务应在几秒钟内启动并运行。

测试应用

现在该应用程序正在运行，您可以对其进行测试。您可以在加载主页http://localhost:8080。但是，为了使自己更有信心在进行更改时该应用程序可以正常工作，您希望自动化测试。您还希望发布HTTP端点的文档。您可以使用Spring REST Docs生成该测试的动态部分作为测试的一部分。

您可以做的第一件事是编写一个简单的完整性检查测试，如果应用程序上下文无法启动，该测试将失败。为此，在测试范围内，将Spring Test和Spring REST Docs添加为项目的依赖项。以下清单显示了使用Maven时要添加的内容：

<dependency>
	<groupId>org.springframework.restdocs</groupId>
	<artifactId>spring-restdocs-mockmvc</artifactId>
	<scope>test</scope>
</dependency>

以下清单显示了完成的pom.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.4.4</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>testing-restdocs</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>testing-restdocs</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<!-- tag::test[] -->
		<dependency>
			<groupId>org.springframework.restdocs</groupId>
			<artifactId>spring-restdocs-mockmvc</artifactId>
			<scope>test</scope>
		</dependency>
		<!-- end::test[] -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
			<!-- tag::asciidoc[] -->
			<plugin>
				<groupId>org.asciidoctor</groupId>
				<artifactId>asciidoctor-maven-plugin</artifactId>
				<executions>
					<execution>
						<id>generate-docs</id>
						<phase>prepare-package</phase>
						<goals>
							<goal>process-asciidoc</goal>
						</goals>
						<configuration>
							<sourceDocumentName>index.adoc</sourceDocumentName>
							<backend>html</backend>
							<attributes>
								<snippets>${project.build.directory}/snippets</snippets>
							</attributes>
						</configuration>
					</execution>
				</executions>
			</plugin>
			<!-- end::asciidoc[] -->
		</plugins>
	</build>

</project>

以下示例显示了使用Gradle时要添加的内容：

testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'

以下清单显示了完成的build.gradle文件：

plugins {
	id 'org.springframework.boot' version '2.4.4'
	id 'io.spring.dependency-management' version '1.0.11.RELEASE'
	id 'java'
	id 'org.asciidoctor.convert' version '1.5.6'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

asciidoctor {
	sourceDir 'src/main/asciidoc'
	attributes \
		'snippets': file('target/snippets')
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	// tag::test[]
	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
	// end::test[]
	testImplementation('org.springframework.boot:spring-boot-starter-test')
}

test {
	useJUnitPlatform()
}

您可以忽略构建文件中的注释。它们在那里是让我们提取文件的一部分以包含在本指南中。

您已经包括了mockmvcREST Docs，它使用Spring MockMvc捕获HTTP内容。如果您自己的应用程序不使用Spring MVC，那么您也可以使用restassured风味，它可以与完整的堆栈集成测试一起使用。

现在，使用@RunWith和@SpringBootTest注释以及一个空的测试方法创建一个测试用例，如以下示例（来自src/test/java/com/example/testingrestdocs/TestingRestdocsApplicationTests.java）所示：

package com.example.testingrestdocs;

import org.junit.jupiter.api.Test;

import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class TestingRestdocsApplicationTests {

	@Test
	public void contextLoads() throws Exception {
	}
}

您可以在IDE或命令行中运行此测试（通过运行./mvnw test或./gradlew test）。

进行完整性检查很高兴，但是您还应该编写一些测试来断言我们的应用程序的行为。一种有用的方法是仅测试MVC层，Spring在该层处理传入的HTTP请求并将其交给您的控制器。为此，您可以使用Spring的，MockMvc并通过使用@WebMvcTest测试用例上的注释要求将其注入。以下示例（来自src/test/java/com/example/testingrestdocs/WebLayerTest.java）展示了如何执行此操作：

@RunWith(SpringRunner.class)
@WebMvcTest(HomeController.class)
public class WebLayerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void shouldReturnDefaultMessage() throws Exception {
        this.mockMvc.perform(get("/"))
            .andExpect(status().isOk())
            .andExpect(content().string(containsString("Hello, World")));
    }
}

生成用于文档的摘要

上一节中的测试发出（模拟）HTTP请求并声明响应。您创建的HTTP API具有动态内容（至少在原则上是这样），因此能够监视测试并从文档中提取HTTP请求真是太好了。Spring REST Docs可以通过生成“代码段”来做到这一点。您可以通过在测试中添加注释和额外的“断言”来使其工作。以下示例（来自src/test/java/com/example/testingrestdocs/WebLayerTest.java）显示了完整的测试：

package com.example.testingrestdocs;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;

import static org.hamcrest.Matchers.containsString;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(HomeController.class)
@AutoConfigureRestDocs(outputDir = "target/snippets")
public class WebLayerTest {

	@Autowired
	private MockMvc mockMvc;

	@Test
	public void shouldReturnDefaultMessage() throws Exception {
		this.mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
				.andExpect(content().string(containsString("Hello, World")))
				.andDo(document("home"));
	}
}

新的注释是@AutoConfigureRestDocs（来自Spring Boot），它为生成的代码片段采用目录位置的参数。新的断言是MockMvcRestDocumentation.document，它接受一个代码段的字符串标识符的参数。

Gradle用户可能更喜欢使用build而不是target作为输出目录。但是，没关系。使用任何您喜欢的。

运行测试，然后查看target/snippets。您应该找到一个名为home（标识符）的目录，其中包含Asciidoctor片段，如下所示：

└── target
    └── snippets
        └── home
            └── curl-request.adoc
            └── http-request.adoc
            └── http-response.adoc
            └── httpie-request.adoc
            └── request-body.adoc
            └── response-body.adoc

HTTP请求和响应的默认代码段为Asciidoctor格式。也有curl和的命令行示例httpie（两个常见和流行的命令行HTTP客户端）。

您可以通过向document()测试中的断言添加参数来创建其他片段。例如，您可以使用PayloadDocumentation.responseFields()代码段记录JSON响应中的每个字段，如以下示例（来自src/test/java/com/example/testingrestdocs/WebLayerTest.java）所示：

this.mockMvc.perform(get("/"))
    ...
    .andDo(document("home", responseFields(
        fieldWithPath("message").description("The welcome message for the user.")
    ));

如果您运行测试，则应该找到一个名为的附加代码段文件response-fields.adoc。它包含一个字段名称和说明表。如果省略字段或输入错误的名称，则测试将失败。这就是REST Docs的强大功能。

您可以创建自定义代码段，并更改代码段的格式和自定义值，例如主机名。有关更多详细信息，请参见Spring REST Docs的文档。

使用片段

要使用生成的代码段，您需要在项目中包含一些Asciidoctor内容，然后在构建时包括这些代码段。要查看这项工作，请创建一个名为的新文件，src/main/asciidoc/index.adoc并根据需要添加代码段。以下示例（来自src/main/asciidoc/index.adoc）展示了如何执行此操作：

= Getting Started With Spring REST Docs

This is an example output for a service running at http://localhost:8080:

.request
include::{snippets}/home/http-request.adoc[]

.response
include::{snippets}/home/http-response.adoc[]

As you can see the format is very simple, and in fact you always get the same message.

此Asciidoc文件的主要功能是，通过使用Asciidoctorinclude指令，它包含两个摘录（冒号和尾括号告诉解析器在这些行上进行特殊处理）。请注意，包含的摘录的路径表示为名为的占位符（attribute在Asciidoctor中为an）{snippets}。在这种简单情况下，唯一的其他标记是=片段的顶部（即1级标题）和标题.之前的标题（“ request”和“ response”）。将该.行上的文本转换为标题。

然后，在构建配置中，您需要将此源文件处理为所选的文档格式。例如，您可以使用Maven生成HTML（在生成HTMLtarget/generated-docs时生成./mvnw package）。以下清单显示了pom.xml文件的Asciidoc部分：

<plugin>
	<groupId>org.asciidoctor</groupId>
	<artifactId>asciidoctor-maven-plugin</artifactId>
	<executions>
		<execution>
			<id>generate-docs</id>
			<phase>prepare-package</phase>
			<goals>
				<goal>process-asciidoc</goal>
			</goals>
			<configuration>
				<sourceDocumentName>index.adoc</sourceDocumentName>
				<backend>html</backend>
				<attributes>
					<snippets>${project.build.directory}/snippets</snippets>
				</attributes>
			</configuration>
		</execution>
	</executions>
</plugin>

如果使用Gradle，build/asciidoc则在运行时会生成./gradlew asciidoctor。以下清单显示了build.gradle文件中与Asciidoctor相关的部分：

plugins {
	...
	id 'org.asciidoctor.convert' version '1.5.6'
}

...

asciidoctor {
    sourceDir 'src/main/asciidoc'
    attributes \
      'snippets': file('target/snippets')
}

Gradle中Asciidoctor源的默认位置是src/doc/asciidoc。我们将设置sourceDir为与Maven的默认值匹配。

概括

恭喜你！您刚刚开发了一个Spring应用程序，并使用Spring Restdocs对其进行了文档记录。您可以将创建的HTML文档发布到静态网站，也可以打包并从应用程序本身提供服务。您的文档将始终是最新的，如果不是，则测试将使您的构建失败。

也可以看看

以下指南也可能会有所帮助：

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。