针对 RESTful 服务的测试驱动文档
本项目的主要目标是通过将使用 Asciidoctor 手写的内容与使用 Spring MVC Test 框架生成的自动生成示例相结合,来轻松记录 RESTful 服务。 结果旨在提供易于阅读的用户指南,类似于 [GitHub 的 API 文档][5],而不是由 Swagger 等工具生成的完全自动化、内容密集的 API 文档。 有关更广泛的介绍,请参阅《记录 RESTful API》演示文档。 [幻灯片][7] 和 [视频录制][8] 都可供使用。
要了解更多关于 Spring REST Docs 的信息,请参阅 [参考文档][9]。
| 名称 | 描述 |
|---|---|
| [restdocs-wiremock][16] | 将 WireMock 哨兵自动生成为 RESTful API 文档的一部分 |
| [restdocsext-jersey][17] | 使 Spring REST Docs 可与 [Jersey 的测试框架][18] 一起使用 |
| [spring-auto-restdocs][19] | 使用反射和 Javadoc 自动生成请求和响应参数的文档 |
| [restdocs-api-spec][20] | Spring REST Docs 的一个扩展，添加了 API 规范支持。目前支持 [OpenAPI 2][21] 和 [OpenAPI 3][22]。 |
暂无开放 Issues，或尚未同步最近议题。