Spring REST Docs 1.1.0.RELEASE

发行版 | Andy Wilkinson | 2016年5月31日 | ...

我很高兴地宣布 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 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 | 问题 | 文档

获取 Spring 新闻通讯

通过 Spring 新闻通讯保持联系

订阅

领先一步

VMware 提供培训和认证,以加速您的进步。

了解更多

获取支持

Tanzu Spring 在一个简单的订阅中提供对 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件。

了解更多

即将举行的活动

查看 Spring 社区中所有即将举行的活动。

查看全部