我很高兴地宣布 Spring REST Docs 1.1.0.RELEASE 已在 Maven Central、JCenter 和我们的 release repository 中可用。

亮点

REST Assured

作为 Spring Framework `MockMvc` 提供的轻量级无服务器文档生成功能的替代方案，您现在可以使用 REST Assured 测试和记录您的 RESTful 服务。这使得 Spring REST Docs 可以覆盖 JVM 的所有角落，甚至更广，让您能够记录任何可以通过 HTTP 访问的内容。

现在，示例中包含了一个使用 Grails 构建、使用 Spock 测试并通过 REST Docs 进行文档化的应用。此外，还有一个使用 REST Docs 为 Ratpack 实现的 API 生成文档的第三方示例。感谢 Jenn Strater 编写了这两个示例。

Markdown

现已添加对生成 Markdown 代码片段的支持。Markdown 本身不如 Asciidoctor 功能强大，但与现有的文档工具链（如 Slate）结合使用时效果很好。

TestNG

除了现有的 JUnit 支持外，您现在还可以将 Spring REST Docs 与 TestNG 结合使用。

可重用代码片段

现在可以一次创建具有一些通用配置的代码片段，然后重用它们。这减少了在记录 API 的常用部分（例如 `self` 链接）时的重复。感谢 Marcel Overdijk 的反馈和贡献，他的拉取请求极大地改进了此新功能。

宽松的代码片段

默认情况下，如果您疏忽了某些内容的文档记录，或者试图记录不存在的内容，Spring REST Docs 会导致测试失败。这对于详细的 API 文档非常有用，但在记录您只想关注请求或响应的特定部分的场景时可能会受到限制。现在，您可以使用宽松的代码片段来记录链接、请求和响应字段以及请求和路径参数，而不必显式忽略您不想记录的所有内容。

将 Spring REST Docs 1.1 与 Spring Boot 1.3 结合使用

默认情况下，Spring Boot 1.3 使用 Spring REST Docs 1.0。要使用 1.1 版本，您应该在 `pom.xml` 或 `build.gradle` 中覆盖 Boot 的依赖项管理中配置的版本。

pom.xml

<properties>
    <spring-restdocs.version>1.1.0.RELEASE</spring-restdocs.version>
</properties>

build.gradle

ext['spring-restdocs.version']=1.1.0.RELEASE

感谢

感谢所有为 Spring REST Docs 做出贡献并帮助塑造 1.1 版本的人。我期待在这里、GitHub、Stack Overflow 和 Twitter 上收到您的反馈。

项目页面 | GitHub | 问题 | 文档