Package org.springframework.restdocs.request

@NullMarked package org.springframework.restdocs.request

Documenting query and path parameters of requests sent to a RESTful API.

Related Packages

Package	Description
org.springframework.restdocs	Core Spring REST Docs classes.

Classes

Class	Description
AbstractParametersSnippet	Abstract TemplatedSnippet subclass that provides a base for snippets that document parameters from a request sent to a RESTful resource.
FormParametersSnippet	A Snippet that documents the form parameters supported by a RESTful resource.
ParameterDescriptor	A descriptor of a request or path parameter.
PathParametersSnippet	A Snippet that documents the path parameters supported by a RESTful resource.
QueryParametersSnippet	A Snippet that documents the query parameters supported by a RESTful resource.
RequestDocumentation	Static factory methods for documenting aspects of a request sent to a RESTful API.
RequestPartDescriptor	A descriptor of a request part.
RequestPartsSnippet	A Snippet that documents the request parts supported by a RESTful resource.