Package org.springframework.restdocs

@NullMarked package org.springframework.restdocs

Core Spring REST Docs classes.

Related Packages

Package	Description
org.springframework.restdocs.cli	Documenting CLI commands required to make a request to a RESTful API.
org.springframework.restdocs.config	Classes for configuring Spring REST Docs.
org.springframework.restdocs.constraints	Documenting a RESTful API's constraints.
org.springframework.restdocs.cookies	Documenting the cookies of a RESTful API's requests and responses.
org.springframework.restdocs.generate	Classes that drive the generation of the documentation snippets.
org.springframework.restdocs.headers	Documenting the headers of a RESTful API's requests and responses.
org.springframework.restdocs.http	Documenting the HTTP request sent to a RESTful API and the HTTP response that is returned.
org.springframework.restdocs.hypermedia	Documenting a RESTful API that uses hypermedia.
org.springframework.restdocs.mockmvc	Core classes for using Spring REST Docs with Spring Test's MockMvc.
org.springframework.restdocs.operation	Operation API that describes a request that was sent and the response that was received when calling a RESTful API.
org.springframework.restdocs.payload	Documenting the payload of a RESTful API's requests and responses.
org.springframework.restdocs.request	Documenting query and path parameters of requests sent to a RESTful API.
org.springframework.restdocs.snippet	Snippet generation.
org.springframework.restdocs.templates	Template API used to render documentation snippets.
org.springframework.restdocs.webtestclient	Core classes for using Spring REST Docs with Spring Framework's WebTestClient.

Class	Description
ManualRestDocumentation	ManualRestDocumentation is used to manually manage the RestDocumentationContext.
RestDocumentationContext	RestDocumentationContext encapsulates the context in which the documentation of a RESTful API is being performed.
RestDocumentationContextProvider	A RestDocumentationContextProvider is used to provide access to the RestDocumentationContext.
RestDocumentationExtension	A JUnit Jupiter Extension used to automatically manage the RestDocumentationContext.