Spring REST Docs 3.0.0-M3 API
Packages
Package
Description
Core Spring REST Docs classes.
Documenting CLI commands required to make a request to a RESTful API.
Classes for configuring Spring REST Docs.
Documenting a RESTful API's constraints.
Classes that drive the generation of the documentation snippets.
Documenting the headers of a RESTful API's requests and responses.
Documenting the HTTP request sent to a RESTful API and the HTTP response that is
returned.
Documenting a RESTful API that uses hypermedia.
Core classes for using Spring REST Docs with Spring Test's MockMvc.
Operation API that describes a request that was sent and the response that was received
when calling a RESTful API.
Support for preprocessing an operation prior to it being documented.
Documenting the payload of a RESTful API's requests and responses.
Documenting query and path parameters of requests sent to a RESTful API.
Core classes for using Spring REST Docs with REST Assured.
Snippet generation.
Template API used to render documentation snippets.
JMustache-based implementation of the template API.
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.