On behalf of everyone who contributed, it's my pleasure to announce that Spring REST Docs 1.2.0.RELEASE has been released. It is available fromMaven Central, JCenter and our release repository.

有什么新功能？

有关 1.2 版本新功能的完整概述，请参阅发行说明。以下是一些亮点。

改进的 Asciidoctor 集成

REST Docs now has a new module, spring-restdocs-asciidoctor, that makes it easier to use the generated snippets in your documentation. A new macro means that you can import multiple snippets for the same operation in a single line. This update to the samples shows the benefit of adopting the macro.

更好地支持文档记录大型和复杂负载

To help to make your documentation easier to consume, the documentation of large and complex payloads can now be split up. Subsections of the payloads can be documented individually allowing your documentation to guide your users through the pieces that matter.

请求和响应体的片段

Snippets that document the body of a request or response are now included in the default snippets. You can also use these snippets explicitly to document a subsection of a large or complex body.

将 Spring REST Docs 1.2 与 Spring Boot 1.5 结合使用

By default, Spring Boot 1.5 uses Spring REST Docs 1.1. To use 1.2, override the version configured in Boot’s dependency management in your pom.xml

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

Or build.gradle

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

下一步是什么？

The project's main focus will now move to Spring REST Docs 2.0. While 1.2 is compatible with the forthcoming Spring Framework 5, 2.0 will require both it and Java 8. This should allow REST Docs to provide support for documenting APIs using WebTestClient and to also take advantage of Java 8 language features.

GitHub | Issues | Documentation | Twitter | Gitter | Stack Overflow