入门·使用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中：
- Spring Tool Suite (STS)
- IntelliJ IDEA

如何完成本指南

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

要从头开始 ，请继续使用Gradle构建。

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

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

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

用Gradle构建

首先，您设置一个基本的构建脚本。在使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含使用Gradle和Maven所需的代码。如果您都不熟悉，请参阅使用Gradle 构建Java项目或使用Maven构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

创建一个Gradle构建文件

以下是最初的Gradle构建文件。

build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.1.6.RELEASE")
    }
}

plugins {
    id "io.spring.dependency-management" version "1.0.5.RELEASE"
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-testing-restdocs'
    version =  '0.1.0'
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

Spring Boot gradle插件提供了许多方便的功能：

它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。
它搜索public static void main()标记为可运行类的方法。
它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

用Maven构建

首先，您设置一个基本的构建脚本。使用Spring构建应用程序时，可以使用任何喜欢的构建系统，但是此处包含了使用Maven所需的代码。如果您不熟悉Maven，请参阅使用Maven 构建Java项目。

创建目录结构

在您选择的项目目录中，创建以下子目录结构；例如， mkdir -p src/main/java/hello在* nix系统上：

└── src
    └── main
        └── java
            └── hello

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>

    <groupId>org.springframework</groupId>
    <artifactId>gs-testing-restdocs</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <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>

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

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

</project>

Spring Boot Maven插件提供了许多方便的功能：

它收集类路径上的所有jar，并构建一个可运行的单个“über-jar”，这使执行和传输服务更加方便。
它搜索public static void main()标记为可运行类的方法。
它提供了一个内置的依赖项解析器，用于设置版本号以匹配Spring Boot依赖项。您可以覆盖所需的任何版本，但是它将默认为Boot选择的一组版本。

使用您的IDE进行构建

阅读如何将本指南直接导入Spring Tool Suite中。
在IntelliJ IDEA中阅读如何使用本指南。

创建一个简单的应用程序

为您的Spring应用程序创建一个新的控制器：

src/main/java/hello/HomeController.java

package hello;

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");
    }

}

使应用程序可执行

创建可用于启动应用程序的“主”类：

src/main/java/hello/Application.java

package hello;

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

@SpringBootApplication
public class Application {

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

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

@Configuration将该类标记为应用程序上下文的Bean定义的源。
@EnableAutoConfiguration告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。
通常您会添加@EnableWebMvc用于Spring MVC应用程序，但是当Spring Boot在类路径中看到spring-webmvc时，它将自动添加它。这会将应用程序标记为Web应用程序，并激活一些关键行为，例如设置DispatcherServlet 。
@ComponentScan告诉Spring在其中寻找其他组件，配置和服务hello包，让它找到HelloController 。

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

构建可执行的JAR

您可以使用Gradle或Maven从命令行运行该应用程序。您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。构建可执行的jar使得在整个开发生命周期中，跨不同环境等等的情况下，可以轻松地将服务作为应用程序进行发布，版本化和部署。

如果您使用Gradle，则可以使用./gradlew bootRun 。或者，您可以通过使用以下命令构建JAR文件： ./gradlew build然后运行JAR文件，如下所示：

java -jar build/libs/gs-testing-restdocs-0.1.0.jar

如果使用Maven，则可以通过使用以下命令运行应用程序./mvnw spring-boot:run 。或者，您可以使用以下命令构建JAR文件： ./mvnw clean package然后运行JAR文件，如下所示：

java -jar target/gs-testing-restdocs-0.1.0.jar

此处描述的步骤将创建可运行的JAR。您还可以构建经典的WAR文件。

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

测试应用

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

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

pom.xml

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

或者如果您正在使用Gradle：

build.gradle

    testCompile("org.springframework.boot:spring-boot-starter-test")
    testCompile("org.springframework.restdocs:spring-restdocs-mockmvc")

您已包括使用Spring MockMvc捕获HTTP内容的REST Docs的“ mockmvc”风格。如果您自己的应用程序未使用Spring MVC，那么还有“放心”的味道，可以与完整的堆栈集成测试一起使用。

然后使用@RunWith和@SpringBootTest注释和空的测试方法：

src/test/java/hello/ApplicationTest.java

package hello;

import org.junit.Test;
import org.junit.runner.RunWith;

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

@RunWith(SpringRunner.class)
@SpringBootTest
public class ApplicationTest {

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

您可以在IDE或命令行中运行此测试（ mvn test要么gradle test ），它应该通过。

进行这样的健全性检查很好，但是您还应该编写一些测试来断言我们应用程序的行为。一种有用的方法是仅测试MVC层，Spring在该层处理传入的HTTP请求并将其交给您的控制器。为此，您可以使用Spring的MockMvc ，并要求使用@WebMvcTest测试用例的注释：

src/test/java/hello/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/hello/WebLayerTest.java

package hello;

import org.junit.Test;
import org.junit.runner.RunWith;

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.context.junit4.SpringRunner;
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;

@RunWith(SpringRunner.class)
@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
            └── httpie-request.adoc
            └── curl-request.adoc
            └── http-request.adoc
            └── http-response.adoc

HTTP请求和响应的默认代码段为Asciidoctor格式，以及curl和httpie （两个常用的命令行HTTP客户端）。

您可以通过将参数添加到document()测试中的断言。例如，您可以使用来记录JSON响应中的每个字段PayloadDocumentation.responseFields()片段：

src/test/java/hello/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.

其主要特征是它使用Asciidoctor包括2个片段include指令（冒号和尾括号告诉解析器在这些行上执行特殊操作）。请注意，包含的摘录的路径表示为占位符-Asciidoctor中的“属性”，称为{snippets} 。在这种简单情况下，唯一的其他标记是顶部的“ =”（这是1级标题）和“”。摘录上的标题（“请求”和“响应”）之前。

然后，在构建配置中，您需要将此源文件处理为所选的文档格式。例如，使用Maven生成HTML（ target/generated-docs当您执行时生成mvnw package ）：

pom.xml

<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

buildscript {
    repositories {
        ...
        jcenter()
    }
    ...
    dependencies {
        ...
        classpath("org.asciidoctor:asciidoctor-gradle-plugin:1.5.3")
    }
}

...
apply plugin: 'org.asciidoctor.convert'

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

Asciidoctor Gradle插件不在Maven Central中，因此您还必须添加jcenter()到Gradle中的buildscipt依赖项。

Gradle中asciidoctor源的默认位置是src/doc/asciidoc 。我们只需要设置sourceDir因为我们更改了位置以匹配Maven的默认位置。

摘要

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

也可以看看

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

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

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