詳解如何用spring Restdocs創(chuàng)建API文檔

更新時(shí)間：2017年05月11日 11:07:47 作者：方志朋

這篇文章將帶你了解如何用spring官方推薦的restdoc去生成api文檔。具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

這篇文章將帶你了解如何用spring官方推薦的restdoc去生成api文檔。本文創(chuàng)建一個(gè)簡單的springboot工程，將http接口通過Api文檔暴露出來。只需要通過 JUnit單元測(cè)試和Spring的MockMVC就可以生成文檔。

準(zhǔn)備工作

你需要15min
Jdk 1.8
maven 3.0+
idea

創(chuàng)建工程

引入依賴，其pom文件：

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

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

通過@SpringBootApplication,開啟springboot

@SpringBootApplication
public class Application {

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

在springboot通常創(chuàng)建一個(gè)controller:

@RestController
public class HomeController {

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

}

啟動(dòng)工程，訪問localhost:8080，瀏覽器顯示：

{“message”:”Hello World”}

證明接口已經(jīng)寫好了，但是如何通過restdoc生存api文檔呢

Restdoc,通過單元測(cè)試生成api文檔

restdocs是通過單元測(cè)試生存snippets文件，然后snippets根據(jù)插件生成htm文檔的。

建一個(gè)單元測(cè)試類：

@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注解開啟了生成snippets文件，并指定了存放位置。

啟動(dòng)單元測(cè)試，測(cè)試通過，你會(huì)發(fā)現(xiàn)在target文件下生成了一個(gè)snippets文件夾，其目錄結(jié)構(gòu)如下：

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

默認(rèn)情況下，snippets是Asciidoctor格式的文件，包括request和reponse，另外其他兩種httpie和curl兩種流行的命令行的http請(qǐng)求模式。

到目前為止，只生成了Snippets文件，需要用Snippets文件生成文檔。

怎么用Snippets

創(chuàng)建一個(gè)新文件src/main/asciidoc/index.adoc ：

用 Spring REST Docs 構(gòu)建文檔

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

這個(gè)例子非常簡單，通過單元測(cè)試和一些簡單的配置就能夠得到api文檔了。

adoc的書寫格式，參考:http://docs.spring.io/spring-restdocs/docs/current/reference/html5/，這里不多講解。

需要使用asciidoctor-maven-plugin插件，在其pom文件加上：

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

這時(shí)只需要通過mvnw package命令就可以生成文檔了。

在/target/generated-docs下有個(gè)index.html，打開這個(gè)html,顯示如下，界面還算簡潔：