Spring REST Docs 2.0.4.RELEASE (see documentation)
Jackson has to be used for creating and parsing JSON
@@ -643,7 +643,7 @@Setup project for Spring REST Docs
+Setup project for Spring REST Docs
Additional configuration for this extension:
@@ -653,7 +653,7 @@<dependency>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-core</artifactId>
- <version>2.0.6</version>
+ <version>2.0.7</version>
<scope>test</scope>
</dependency>
@@ -690,7 +690,7 @@ Usage
<docletArtifact>
<groupId>capital.scalable</groupId>
<artifactId>spring-auto-restdocs-json-doclet</artifactId> (3)
- <version>2.0.6</version>
+ <version>2.0.7</version>
</docletArtifact>
<destDir>generated-javadoc-json</destDir> (2)
<reportOutputDirectory>${project.build.directory}</reportOutputDirectory> (2)
@@ -735,8 +735,8 @@ Usage
}
dependencies {
- testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.6'
- jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.6' (3)
+ testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '2.0.7'
+ jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '2.0.7' (3)
}
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -2007,10 +2007,10 @@ Custom snippet<
Snippet customization
Provide your own template in org/springframework/restdocs/templates/asciidoctor (or markdown) package of your resources.
-You can override REST Docs templates
+You can override REST Docs templates
and Auto REST Docs templates.
Important is to omit default- part from the template name so that the resolution algorithm will prefer this custom template.
-See also original documentation for additional details.
+See also original documentation for additional details.
.description.
The value is the description and can contain placeholders for annotation methods,
e.g. ${value} to get the content of value().
-For more details, see original documentation of here.
+For more details, see original documentation of here.
Example for the constraint annotation myproject.constraints.OneOf:
Page. This is then mentioned in request and response snippets by linking
to common section explaining the details of supported paging parameters/fields.
This section has to be created manually and must be tagged as [[overview-pagination]].
-See example project for paging section template.
+See example project for paging section template.
binary replacement: replaces content with <binary> for common mime types
binary replacement: replaces content with <binary> for common mime types
limit JSON array length: limits all JSON arrays to 3 items
+limit JSON array length: limits all JSON arrays to 3 items
Deprecation is shown in the title of an endpoint (also visible in TOC) and description.
Field’s deprecation is shown in description column of request/response table.
-See how it looks in the example project.
@see Javadoc tag comment will be added to the main description section of an endpoint or a field.
Currently supports only HTML links. Does not support Java code references.
-See how it looks in the example project.
We use version 2.0.3.RELEASE of Spring REST Docs in this example.
+We use version 2.0.4.RELEASE of Spring REST Docs in this example.
You find the currently required version in pom.xml:
<dependency>
<groupId>org.springframework.restdocs</groupId>
<artifactId>spring-restdocs-core</artifactId>
- <version>2.0.3.RELEASE</version>
+ <version>2.0.4.RELEASE</version>
<classifier>test</classifier>
<scope>test</scope>
</dependency>
@@ -2483,13 +2483,13 @@ git clone git@github.com:spring-projects/spring-restdocs.git
cd spring-restdocs
git fetch --tags
-git checkout tags/v2.0.3.RELEASE
+git checkout tags/v2.0.4.RELEASE
./gradlew build
Afterwards the test JAR is located at
-spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-2.0.3.RELEASE-test.jar
+spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-2.0.4.RELEASE-test.jar
and has to be installed with the Maven command shown in the section above.