This version is still in development and is not considered stable yet. For the latest stable version, please use Spring REST Docs 4.0.0!

Default Snippets

A number of snippets are produced automatically when you document a request and response.

Snippet Description

Snippet	Description
`curl-request.adoc`	Contains the `curl` command that is equivalent to the `MockMvc` call that is being documented.
`httpie-request.adoc`	Contains the `HTTPie` command that is equivalent to the `MockMvc` call that is being documented.
`http-request.adoc`	Contains the HTTP request that is equivalent to the `MockMvc` call that is being documented.
`http-response.adoc`	Contains the HTTP response that was returned.
`request-body.adoc`	Contains the body of the request that was sent.
`response-body.adoc`	Contains the body of the response that was returned.

curl-request.adoc

Contains the curl command that is equivalent to the MockMvc call that is being documented.

httpie-request.adoc

Contains the HTTPie command that is equivalent to the MockMvc call that is being documented.

http-request.adoc

Contains the HTTP request that is equivalent to the MockMvc call that is being documented.

http-response.adoc

Contains the HTTP response that was returned.

request-body.adoc

Contains the body of the request that was sent.

response-body.adoc

Contains the body of the response that was returned.

You can configure which snippets are produced by default. See the configuration section for more information.