這篇文章將帶你瞭解如何用spring官方推薦的restdoc去生成api文件。本文建立一個簡單的springboot工程，將http介面通過Api文件暴露出來。只需要通過 JUnit單元測試和Spring的MockMVC就可以生成文件。完整專案的原始碼來源 技術支援一七九一七四三三八零
準備工作
你需要15min
Jdk 1.8
maven 3.0+
idea
建立工程
引入依賴，其pom檔案：
通過@SpringBootApplication,開啟springboot
<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通常建立一個controller:
@RestController
public class HomeController {``
@GetMapping("/")
public Map<String, Object> greeting() {
return Collections.singletonMap("message", "Hello World");
}
}
複製程式碼啟動工程，訪問localhost:8080，瀏覽器顯示：
{“message”:”Hello World”}
複製程式碼證明介面已經寫好了，但是如何通過restdoc生存api文件呢
Restdoc,通過單元測試生成api文件 restdocs是通過單元測試生存snippets檔案，然後snippets根據外掛生成htm文件的。
建一個單元測試類：
@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檔案，並指定了存放位置。
啟動單元測試，測試通過，你會發現在target檔案下生成了一個snippets資料夾，其目錄結構如下：
└── target
└── snippets
└── home
└── httpie-request.adoc
└── curl-request.adoc
└── http-request.adoc
└── http-response.adoc
複製程式碼預設情況下，snippets是Asciidoctor格式的檔案，包括request和reponse，另外其他兩種httpie和curl兩種流行的命令列的http請求模式。 到目前為止，只生成了Snippets檔案，需要用Snippets檔案生成文件。