很高兴宣布 Spring REST Docs 1.1.0.RELEASE 版本现已发布，可从 Maven Central、JCenter 和我们的发布仓库获取。

亮点

REST Assured

作为 Spring Framework 的 MockMvc 提供的轻量级无服务器文档生成方式的替代方案，您现在可以使用 REST Assured 来测试和记录您的 RESTful 服务。这使得 Spring REST Docs 能够触达 JVM 的各个角落及其他领域，让您能够记录任何可通过 HTTP 访问的内容。

这些示例现在包含一个使用 REST Docs 文档化、使用 Grails 构建并使用 Spock 测试的应用。还有一个使用 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 Boot 1.3 中使用 Spring REST Docs 1.1

默认情况下，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 | 问题 | 文档