Uses of Class
org.springframework.restdocs.request.RequestPartDescriptor
Packages that use RequestPartDescriptor
Package
Description
Documenting query and path parameters of requests sent to a RESTful API.
-
Uses of RequestPartDescriptor in org.springframework.restdocs.request
Methods in org.springframework.restdocs.request that return RequestPartDescriptorModifier and TypeMethodDescriptionfinal RequestPartDescriptorRequestPartDescriptor.optional()Marks the request part as optional.static RequestPartDescriptorRequestDocumentation.partWithName(String name) Creates aRequestPartDescriptorthat describes a request part with the givenname.Methods in org.springframework.restdocs.request with parameters of type RequestPartDescriptorModifier and TypeMethodDescriptionfinal RequestPartsSnippetRequestPartsSnippet.and(RequestPartDescriptor... additionalDescriptors) Returns a newRequestPartsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.static RequestPartsSnippetRequestDocumentation.relaxedRequestParts(Map<String, Object> attributes, RequestPartDescriptor... descriptors) Returns aSnippetthat will document the parts from the API operation's request.static RequestPartsSnippetRequestDocumentation.relaxedRequestParts(RequestPartDescriptor... descriptors) Returns aSnippetthat will document the parts from the API operation's request.static RequestPartsSnippetRequestDocumentation.requestParts(Map<String, Object> attributes, RequestPartDescriptor... descriptors) Returns aSnippetthat will document the parts from the API operation's request.static RequestPartsSnippetRequestDocumentation.requestParts(RequestPartDescriptor... descriptors) Returns aSnippetthat will document the parts from the API operation's request.Method parameters in org.springframework.restdocs.request with type arguments of type RequestPartDescriptorModifier and TypeMethodDescriptionfinal RequestPartsSnippetRequestPartsSnippet.and(List<RequestPartDescriptor> additionalDescriptors) Returns a newRequestPartsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.static RequestPartsSnippetRequestDocumentation.relaxedRequestParts(List<RequestPartDescriptor> descriptors) Returns aSnippetthat will document the parts from the API operation's request.static RequestPartsSnippetRequestDocumentation.relaxedRequestParts(Map<String, Object> attributes, List<RequestPartDescriptor> descriptors) Returns aSnippetthat will document the parts from the API operation's request.static RequestPartsSnippetRequestDocumentation.requestParts(List<RequestPartDescriptor> descriptors) Returns aSnippetthat will document the parts from the API operation's request.static RequestPartsSnippetRequestDocumentation.requestParts(Map<String, Object> attributes, List<RequestPartDescriptor> descriptors) Returns aSnippetthat will document the parts from the API operation's request.Constructor parameters in org.springframework.restdocs.request with type arguments of type RequestPartDescriptorModifierConstructorDescriptionprotectedRequestPartsSnippet(List<RequestPartDescriptor> descriptors) Creates a newRequestPartsSnippetthat will document the request's parts using the givendescriptors.protectedRequestPartsSnippet(List<RequestPartDescriptor> descriptors, boolean ignoreUndocumentedParts) Creates a newRequestPartsSnippetthat will document the request's parts using the givendescriptors.protectedRequestPartsSnippet(List<RequestPartDescriptor> descriptors, Map<String, Object> attributes) Creates a newRequestPartsSnippetthat will document the request's parts using the givendescriptors.protectedRequestPartsSnippet(List<RequestPartDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedParts) Creates a newRequestPartsSnippetthat will document the request's parts using the givendescriptors.