Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch '2.0.x'

Browse Source 
# Conflicts:
#	docs/src/docs/asciidoc/configuration.adoc
#	docs/src/docs/asciidoc/customizing-requests-and-responses.adoc
#	docs/src/docs/asciidoc/documenting-your-api.adoc
#	docs/src/docs/asciidoc/getting-started.adoc
This commit is contained in:
Andy Wilkinson
2022-01-11 12:05:39 +00:00
parent adbc880b70 232f581f67
commit e78998de15
8 changed files with 52 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/src/docs/asciidoc/configuration.adoc
View File

@@ -3,11 +3,15 @@
This section covers how to configure Spring REST Docs.
[[configuration-uris]]
=== Documented URIs
This section covers configuring documented URIs.
[[configuration-uris-mockmvc]]
==== MockMvc URI Customization
@@ -30,12 +34,10 @@ This configuration is applied by `MockMvcRestDocumentationConfigurer`.
You can use its API to change one or more of the defaults to suit your needs.
The following example shows how to do so:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/mockmvc/CustomUriConfiguration.java[tags=custom-uri-configuration]
----
====
NOTE: If the port is set to the default for the configured scheme (port 80 for HTTP or port 443 for HTTPS), it is omitted from any URIs in the generated snippets.
@@ -50,13 +52,11 @@ When using WebTestClient, the default base for URIs documented by Spring REST Do
You can customize this base by using the {spring-framework-api}/org/springframework/test/web/reactive/server/WebTestClient.Builder.html#baseUrl-java.lang.String-[ `baseUrl(String)` method on `WebTestClient.Builder`].
The following example shows how to do so:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/webtestclient/CustomUriConfiguration.java[tags=custom-uri-configuration]
----
<1> Configure the base of documented URIs to be `https://api.example.com`.
====
@@ -67,7 +67,6 @@ The default snippet encoding is `UTF-8`.
You can change the default snippet encoding by using the `RestDocumentationConfigurer` API.
For example, the following examples use `ISO-8859-1`:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -94,7 +93,6 @@ Markdown is also supported out of the box.
You can change the default format by using the `RestDocumentationConfigurer` API.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -124,7 +122,6 @@ Six snippets are produced by default:
You can change the default snippet configuration during setup by using the `RestDocumentationConfigurer` API.
The following examples produce only the `curl-request` snippet by default:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -145,7 +142,6 @@ include::{examples-dir}/com/example/webtestclient/CustomDefaultSnippets.java[tag
You can configure default request and response preprocessors during setup by using the `RestDocumentationConfigurer` API.
The following examples remove the `Foo` headers from all requests and pretty print all responses:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -161,3 +157,5 @@ include::{examples-dir}/com/example/webtestclient/CustomDefaultOperationPreproce
----
<1> Apply a request preprocessor that removes the header named `Foo`.
<2> Apply a response preprocessor that pretty prints its content.

2
docs/src/docs/asciidoc/contributing.adoc
View File

@@ -29,3 +29,5 @@ If you would like an enhancement to be made to Spring REST Docs, pull requests a
The source code is on {github}[GitHub].
You may want to search the {github}/issues?q=is%3Aissue[existing issues] and {github}/pulls?q=is%3Apr[pull requests] to see if the enhancement has already been proposed.
You may also want to {github}/issues/new[open a new issue] to discuss a possible enhancement before work on it begins.

5
docs/src/docs/asciidoc/customizing-requests-and-responses.adoc
View File

@@ -8,7 +8,6 @@ Preprocessing is configured by calling `document` with an `OperationRequestPrepr
You can obtain instances by using the static `preprocessRequest` and `preprocessResponse` methods on `Preprocessors`.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -29,7 +28,6 @@ Alternatively, you may want to apply the same preprocessors to every test.
You can do so by using the `RestDocumentationConfigurer` API in your `@Before` method to configure the preprocessors.
For example, to remove the `Foo` header from all requests and pretty print all responses, you could do one of the following (depending on your testing environment):
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -49,7 +47,6 @@ include::{examples-dir}/com/example/webtestclient/EveryTestPreprocessing.java[ta
Then, in each test, you can perform any configuration specific to that test.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -130,3 +127,5 @@ If one of the built-in preprocessors does not meet your needs, you can write you
You can then use your custom preprocessor in exactly the same way as any of the built-in preprocessors.
If you want to modify only the content (body) of a request or response, consider implementing the `ContentModifier` interface and using it with the built-in `ContentModifyingOperationPreprocessor`.

68
docs/src/docs/asciidoc/documenting-your-api.adoc
View File

@@ -11,7 +11,6 @@ This section provides more details about using Spring REST Docs to document your
Spring REST Docs provides support for documenting the links in a https://en.wikipedia.org/wiki/HATEOAS[hypermedia-based] API.
The following examples show how to use it:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -34,7 +33,6 @@ Uses the static `links` method on `org.springframework.restdocs.hypermedia.Hyper
Uses the static `linkWithRel` method on `org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<3> Expect a link whose `rel` is `bravo`.
The result is a snippet named `links.adoc` that contains a table describing the resource's links.
TIP: If a link in the response has a `title`, you can omit the description from its descriptor and the `title` is used.
@@ -65,7 +63,6 @@ Two link formats are understood by default:
If you use Atom- or HAL-format links but with a different content type, you can provide one of the built-in `LinkExtractor` implementations to `links`.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -93,12 +90,10 @@ Rather than documenting links that are common to every response, such as `self`
To do so, you can build on the <<documenting-your-api-reusing-snippets,support for reusing snippets>> to add link descriptors to a snippet that is preconfigured to ignore certain links.
The following example shows how to do so:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Hypermedia.java[tags=ignore-links]
----
====
@@ -119,7 +114,6 @@ To provide more detailed documentation of a request or response payload, support
Consider the following payload:
====
[source,json,indent=0]
----
{
@@ -129,11 +123,9 @@ Consider the following payload:
}
}
----
====
You can document the previous example's fields as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -168,7 +160,6 @@ Similarly, the test also fails if a documented field is not found in the payload
If you do not want to provide detailed documentation for all of the fields, an entire subsection of a payload can be documented.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -201,11 +192,15 @@ This can be useful when documenting a particular scenario where you want to focu
TIP: By default, Spring REST Docs assumes that the payload you are documenting is JSON.
If you want to document an XML payload, the content type of the request or response must be compatible with `application/xml`.
[[documenting-your-api-request-response-payloads-fields-json]]
===== Fields in JSON Payloads
This section describes how to work with fields in JSON payloads.
[[documenting-your-api-request-response-payloads-fields-json-field-paths]]
====== JSON Field Paths
@@ -218,7 +213,6 @@ The two different notations can be used in the same path (for example, `a['b']`)
Consider the following JSON payload:
====
[source,json,indent=0]
----
{
@@ -238,7 +232,6 @@ Consider the following JSON payload:
}
}
----
====
In the preceding JSON payload, the following paths are all present:
@@ -275,7 +268,6 @@ In the preceding JSON payload, the following paths are all present:
|`['a']['e.dot']`
|The string `four`
|===
You can also document a payload that uses an array at its root.
@@ -283,7 +275,6 @@ The path `[]` refers to the entire array.
You can then use bracket or dot notation to identify fields within the array's entries.
For example, `[].id` corresponds to the `id` field of every object found in the following array:
====
[source,json,indent=0]
----
[
@@ -295,12 +286,10 @@ For example, `[].id` corresponds to the `id` field of every object found in the
}
]
----
====
You can use `\*` as a wildcard to match fields with different names.
For example, `users.*.role` could be used to document the role of every user in the following JSON:
====
[source,json,indent=0]
----
{
@@ -314,7 +303,8 @@ For example, `users.*.role` could be used to document the role of every user in
}
}
----
====
[[documenting-your-api-request-response-payloads-fields-json-field-types]]
====== JSON Field Types
@@ -353,7 +343,6 @@ The result of the `toString` method of the supplied `Object` is used in the docu
Typically, one of the values enumerated by `JsonFieldType` is used.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -375,6 +364,8 @@ include::{examples-dir}/com/example/webtestclient/Payload.java[tags=explicit-typ
This section describes how to work with XML payloads.
[[documenting-your-api-request-response-payloads-fields-xml-field-paths]]
====== XML Field Paths
@@ -399,7 +390,6 @@ This lets the descriptors for a repeated portion of a request or response payloa
Consider an endpoint that returns a book:
====
[source,json,indent=0]
----
{
@@ -407,13 +397,11 @@ Consider an endpoint that returns a book:
"author": "Jane Austen"
}
----
====
The paths for `title` and `author` are `title` and `author`, respectively.
Now consider an endpoint that returns an array of books:
====
[source,json,indent=0]
----
[{
@@ -425,23 +413,19 @@ Now consider an endpoint that returns an array of books:
"author": "Harper Lee"
}]
----
====
The paths for `title` and `author` are `[].title` and `[].author`, respectively.
The only difference between the single book and the array of books is that the fields' paths now have a `[].` prefix.
You can create the descriptors that document a book as follows:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Payload.java[tags=book-descriptors]
----
====
You can then use them to document a single book, as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -458,7 +442,6 @@ include::{examples-dir}/com/example/webtestclient/Payload.java[tags=single-book]
You can also use the descriptors to document an array of books, as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -483,12 +466,13 @@ include::{examples-dir}/com/example/webtestclient/Payload.java[tags=book-array]
If a payload is large or structurally complex, it can be useful to document individual sections of the payload.
REST Docs let you do so by extracting a subsection of the payload and then documenting it.
[[documenting-your-api-request-response-payloads-subsections-body]]
===== Documenting a Subsection of a Request or Response Body
Consider the following JSON response body:
====
[source,json,indent=0]
----
{
@@ -504,11 +488,9 @@ Consider the following JSON response body:
}
}
----
====
You can produce a snippet that documents the `temperature` object as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -529,7 +511,6 @@ To produce a snippet for the request body, you can use `requestBody` in place of
The result is a snippet with the following contents:
====
[source,json,indent=0]
----
{
@@ -539,19 +520,16 @@ The result is a snippet with the following contents:
}
}
----
====
To make the snippet's name distinct, an identifier for the subsection is included.
By default, this identifier is `beneath-${path}`.
For example, the preceding code results in a snippet named `response-body-beneath-weather.temperature.adoc`.
You can customize the identifier by using the `withSubsectionId(String)` method, as follows:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Payload.java[tags=custom-subsection-id]
----
====
The result is a snippet named `request-body-temp.adoc`.
@@ -563,7 +541,6 @@ The result is a snippet named `request-body-temp.adoc`.
As well as documenting a subsection of a request or response body, you can also document the fields in a particular subsection.
You can produce a snippet that documents the fields of the `temperature` object (`high` and `low`) as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -596,7 +573,6 @@ You can document a request's parameters by using `requestParameters`.
You can include request parameters in a `GET` request's query string.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -624,7 +600,6 @@ Uses the static `parameterWithName` method on `org.springframework.restdocs.requ
You can also include request parameters as form data in the body of a POST request.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -659,7 +634,6 @@ This can be useful when documenting a particular scenario where you only want to
You can document a request's path parameters by using `pathParameters`.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -706,7 +680,6 @@ Doing so prevents it from appearing in the generated snippet while avoiding the
You can use `requestParts` to document the parts of a multipart request.
The following example shows how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -742,6 +715,7 @@ If you do not want to document a request part, you can mark it as ignored.
This prevents it from appearing in the generated snippet while avoiding the failure described earlier.
[[documenting-your-api-request-parts-payloads]]
=== Request Part Payloads
@@ -754,7 +728,6 @@ You can document the payload of a request part in much the same way as the <<doc
You can generate a snippet containing the body of a request part as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -781,7 +754,6 @@ For example, documenting a part named `metadata` produces a snippet named `reque
You can document a request part's fields in much the same way as the fields of a request or response, as follows:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -819,13 +791,14 @@ This can be useful when documenting a particular scenario where you only want to
For further information on describing fields, documenting payloads that use XML, and more, see the <<documenting-your-api-request-response-payloads,section on documenting request and response payloads>>.
[[documenting-your-api-http-headers]]
=== HTTP Headers
You can document the headers in a request or response by using `requestHeaders` and `responseHeaders`, respectively.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -868,17 +841,14 @@ To avoid repetition when documenting such resources, you can reuse a `Snippet` c
First, create the `Snippet` that describes the common elements.
The following example shows how to do so:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/SnippetReuse.java[tags=field]
----
====
Second, use this snippet and add further descriptors that are resource-specific.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -904,7 +874,6 @@ Spring REST Docs provides a number of classes that can help you to document cons
You can use an instance of `ConstraintDescriptions` to access descriptions of a class's constraints.
The following example shows how to do so:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Constraints.java[tags=constraints]
@@ -912,7 +881,6 @@ include::{examples-dir}/com/example/Constraints.java[tags=constraints]
<1> Create an instance of `ConstraintDescriptions` for the `UserInput` class.
<2> Get the descriptions of the `name` property's constraints.
This list contains two descriptions: one for the `NotNull` constraint and one for the `Size` constraint.
====
The {samples}/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java[`ApiDocumentation`] class in the Spring HATEOAS sample shows this functionality in action.
@@ -1026,7 +994,6 @@ call that is being documented.
| `response-body.adoc`
| Contains the body of the response that was returned.
|===
You can configure which snippets are produced by default.
@@ -1072,7 +1039,6 @@ A parameterized output directory is particularly useful in combination with a `@
It lets documentation be configured once in a setup method and then reused in every test in the class.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -1084,7 +1050,6 @@ include::{examples-dir}/com/example/mockmvc/ParameterizedOutput.java[tags=parame
----
include::{examples-dir}/com/example/webtestclient/ParameterizedOutput.java[tags=parameterized-output]
----
====
With this configuration in place, every call to the service you are testing produces the <<documenting-your-api-default-snippets,default snippets>> without any further configuration.
Take a look at the `GettingStartedDocumentation` classes in each of the sample applications to see this functionality in action.
@@ -1096,6 +1061,8 @@ Take a look at the `GettingStartedDocumentation` classes in each of the sample a
This section describes how to customize the output of Spring REST Docs.
[[documenting-your-api-customizing-snippets]]
==== Customizing the Generated Snippets
@@ -1127,7 +1094,6 @@ A concrete example is the addition of a constraints column and a title when docu
The first step is to provide a `constraints` attribute for each field that you document and to provide a `title` attribute.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -1149,7 +1115,6 @@ include::{examples-dir}/com/example/webtestclient/Payload.java[tags=constraints]
The second step is to provide a custom template named `request-fields.snippet` that includes the information about the fields' constraints in the generated snippet's table and adds a title.
The following example shows how to do so:
====
[source,indent=0]
----
.{{title}} <1>
@@ -1168,4 +1133,5 @@ The following example shows how to do so:
<1> Add a title to the table.
<2> Add a new column named "Constraints".
<3> Include the descriptors' `constraints` attribute in each row of the table.
====

42
docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -22,7 +22,6 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/rest-notes-spring-hateoas[Spring HATEOAS]
| Gradle
| Demonstrates the creation of a getting started guide and an API guide for a service implemented by using https://projects.spring.io/spring-hateoas/[Spring HATEOAS].
|===
[cols="3,2,10"]
@@ -33,7 +32,6 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/web-test-client[WebTestClient]
| Gradle
| Demonstrates the use of Spring REST docs with Spring WebFlux's WebTestClient.
|===
[cols="3,2,10"]
@@ -53,9 +51,10 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/junit5[JUnit 5]
| Gradle
| Demonstrates the use of Spring REST Docs with https://junit.org/junit5/[JUnit 5].
|===
[[getting-started-requirements]]
=== Requirements
@@ -64,6 +63,8 @@ Spring REST Docs has the following minimum requirements:
* Java 17
* Spring Framework 6
[[getting-started-build-configuration]]
=== Build configuration
@@ -71,7 +72,6 @@ The first step in using Spring REST Docs is to configure your project's build.
The {samples}/rest-notes-spring-hateoas[Spring HATEOAS] and {samples}/rest-notes-spring-data-rest[Spring Data REST] samples contain a `build.gradle` and `pom.xml`, respectively, that you may wish to use as a reference.
The key parts of the configuration are described in the following listings:
====
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
@@ -163,7 +163,8 @@ If you want to use `WebTestClient`, add a dependency on `spring-restdocs-webtest
<8> Configure the snippets directory as an input.
<9> Configure the use of the `asciidoctorExt` configuration for extensions.
<10> Make the task depend on the test task so that the tests are run before the documentation is created.
====
[[getting-started-build-configuration-packaging-the-documentation]]
==== Packaging the Documentation
@@ -176,7 +177,6 @@ To do so, configure your project's build so that:
The following listings show how to do so in both Maven and Gradle:
====
[source,xml,indent=0,role="primary"]
.Maven
----
@@ -227,7 +227,6 @@ The following listings show how to do so in both Maven and Gradle:
----
<1> Ensure that the documentation has been generated before the jar is built.
<2> Copy the generated documentation into the jar's `static/docs` directory.
====
@@ -245,19 +244,19 @@ Exactly how you set up your tests depends on the test framework that you use.
Spring REST Docs provides first-class support for JUnit 4 and JUnit 5.
Other frameworks, such as TestNG, are also supported, although slightly more setup is required.
[[getting-started-documentation-snippets-setup-junit]]
===== Setting up Your JUnit 4 Tests
When using JUnit 4, the first step in generating documentation snippets is to declare a `public` `JUnitRestDocumentation` field that is annotated as a JUnit `@Rule`.
The following example shows how to do so:
====
[source,java,indent=0]
----
@Rule
public JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
----
====
By default, the `JUnitRestDocumentation` rule is automatically configured with an output directory based on your project's build tool:
@@ -270,24 +269,20 @@ By default, the `JUnitRestDocumentation` rule is automatically configured with a
| Gradle
| `build/generated-snippets`
|===
You can override the default by providing an output directory when you create the `JUnitRestDocumentation` instance.
The following example shows how to do so:
====
[source,java,indent=0]
----
@Rule
public JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("custom");
----
====
Next, you must provide an `@Before` method to configure MockMvc or WebTestClient.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -315,23 +310,19 @@ See the <<configuration, configuration section>> for more information.
When using JUnit 5, the first step in generating documentation snippets is to apply the `RestDocumentationExtension` to your test class.
The following example shows how to do so:
====
[source,java,indent=0]
----
@ExtendWith(RestDocumentationExtension.class)
public class JUnit5ExampleTests {
----
====
When testing a typical Spring application, you should also apply the `SpringExtension`:
====
[source,java,indent=0]
----
@ExtendWith({RestDocumentationExtension.class, SpringExtension.class})
public class JUnit5ExampleTests {
----
====
The `RestDocumentationExtension` is automatically configured with an output directory based on your project's build tool:
@@ -344,7 +335,6 @@ The `RestDocumentationExtension` is automatically configured with an output dire
| Gradle
| `build/generated-snippets`
|===
If you are using JUnit 5.1, you can override the default by registering the extension as a field in your test class and providing an output directory when creating it.
@@ -363,7 +353,6 @@ public class JUnit5ExampleTests {
Next, you must provide a `@BeforeEach` method to configure MockMvc or WebTestClient.
The following listings show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -385,8 +374,8 @@ See the <<configuration, configuration section>> for more information.
===== Setting up your tests without JUnit
[[getting-started-documentation-snippets-setup-manual]]
===== Setting up your tests without JUnit
The configuration when JUnit is not being used is largely similar to when it is being used.
This section describes the key differences.
@@ -396,18 +385,15 @@ The first difference is that you should use `ManualRestDocumentation` in place o
Also, you do not need the `@Rule` annotation.
The following example shows how to use `ManualRestDocumentation`:
====
[source,java,indent=0]
----
private ManualRestDocumentation restDocumentation = new ManualRestDocumentation();
----
====
Secondly, you must call `ManualRestDocumentation.beforeTest(Class, String)` before each test.
You can do so as part of the method that configures MockMvc or WebTestClient.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -423,12 +409,12 @@ include::{examples-dir}/com/example/webtestclient/ExampleApplicationTestNgTests.
Finally, you must call `ManualRestDocumentation.afterTest` after each test.
The following example shows how to do so with TestNG:
====
[source,java,indent=0]
----
include::{examples-dir}/com/example/mockmvc/ExampleApplicationTestNgTests.java[tags=teardown]
----
====
[[getting-started-documentation-snippets-invoking-the-service]]
==== Invoking the RESTful Service
@@ -436,7 +422,6 @@ include::{examples-dir}/com/example/mockmvc/ExampleApplicationTestNgTests.java[t
Now that you have configured the testing framework, you can use it to invoke the RESTful service and document the request and response.
The following examples show how to do so:
====
[source,java,indent=0,role="primary"]
.MockMvc
----
@@ -491,16 +476,15 @@ The default location of the source files and the resulting HTML files depends on
| Gradle
| `src/docs/asciidoc/*.adoc`
| `build/asciidoc/html5/*.html`
|===
You can then include the generated snippets in the manually created Asciidoc file (described earlier in this section) by using the https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
You can use the `snippets` attribute that is automatically set by `spring-restdocs-asciidoctor` configured in the <<getting-started-build-configuration,build configuration>> to reference the snippets output directory.
The following example shows how to do so:
====
[source,adoc,indent=0]
----
\include::{snippets}/index/curl-request.adoc[]
----
====

2
docs/src/docs/asciidoc/introduction.adoc
View File

@@ -18,3 +18,5 @@ Two key parts of each resource's description are the details of the HTTP request
Spring REST Docs lets you work with these resources and the HTTP requests and responses, shielding your documentation from the inner-details of your service's implementation.
This separation helps you document your service's API rather than its implementation.
It also frees you to evolve the implementation without having to rework the documentation.

26
docs/src/docs/asciidoc/working-with-asciidoctor.adoc
View File

@@ -21,6 +21,8 @@ Asciidoctor is the tool that produces content (usually as HTML) from Asciidoc fi
This section covers how to include Asciidoc snippets.
[[working-with-asciidoctor-including-snippets-operation]]
==== Including Multiple Snippets for an Operation
@@ -30,12 +32,10 @@ It is made available by including `spring-restdocs-asciidoctor` in your project'
The target of the macro is the name of the operation.
In its simplest form, you can use the macro to include all of the snippets for an operation, as shown in the following example:
====
[source,indent=0]
----
operation::index[]
----
====
You can use the operation macro also supports a `snippets` attribute.
The `snippets` attribute to select the snippets that should be included.
@@ -43,16 +43,13 @@ The attribute's value is a comma-separated list.
Each entry in the list should be the name of a snippet file (minus the `.adoc` suffix) to include.
For example, only the curl, HTTP request, and HTTP response snippets can be included, as shown in the following example:
====
[source,indent=0]
----
operation::index[snippets='curl-request,http-request,http-response']
----
====
The preceding example is the equivalent of the following:
====
[source,adoc,indent=0]
----
[[example_curl_request]]
@@ -71,7 +68,8 @@ The preceding example is the equivalent of the following:
\include::{snippets}/index/http-response.adoc[]
----
====
[[working-with-asciidoctor-including-snippets-operation-titles]]
===== Section Titles
@@ -117,12 +115,10 @@ You can customize the default titles by using document attributes.
The name of the attribute should be `operation-{snippet}-title`.
For example, to customize the title of the `curl-request` snippet to be "Example request", you can use the following attribute:
====
[source,indent=0]
----
:operation-curl-request-title: Example request
----
====
@@ -133,12 +129,10 @@ The https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[
You can use the `snippets` attribute (which is automatically set by `spring-restdocs-asciidoctor` configured in the <<getting-started-build-configuration, build configuration>>) to reference the snippets output directory.
The following example shows how to do so:
====
[source,indent=0]
----
\include::{snippets}/index/curl-request.adoc[]
----
====
@@ -156,14 +150,12 @@ The appearance of the table can be customized, either by providing some addition
Asciidoctor has rich support for https://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns].
As the following example shows, you can specify the widths of a table's columns by using the `cols` attribute:
====
[source,indent=0]
----
[cols="1,3"] <1>
\include::{snippets}/index/links.adoc[]
----
<1> The table's width is split across its two columns, with the second column being three times as wide as the first.
====
@@ -173,14 +165,12 @@ As the following example shows, you can specify the widths of a table's columns
You can specify the title of a table by using a line prefixed by a `.`.
The following example shows how to do so:
====
[source,indent=0]
----
.Links <1>
\include::{snippets}/index/links.adoc[]
----
<1> The table's title will be `Links`.
====
@@ -195,14 +185,14 @@ All of the default Asciidoctor snippet templates perform this escaping automatic
If you write your own custom templates you may want to use this lamba.
The following example shows how to escape `|` characters in a cell that contains the value of a `description` attribute:
====
----
| {{#tableCellContent}}{{description}}{{/tableCellContent}}
----
====
==== Further Reading
[[working-with-asciidoctor-further-reading]]
=== Further Reading
See the https://asciidoctor.org/docs/user-manual/#tables[Tables section of the Asciidoctor user manual] for more information about customizing tables.

2
docs/src/docs/asciidoc/working-with-markdown.adoc
View File

@@ -22,3 +22,5 @@ Spring REST Docs' default Markdown snippet templates use https://michelf.ca/proj
Markdown has no built-in support for including one Markdown file in another.
To include the generated snippets of Markdown in your documentation, you should use an additional tool that supports this functionality.
One example that is particularly well-suited to documenting APIs is https://github.com/tripit/slate[Slate].