Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

O

OBJECT - Enum constant in enum class org.springframework.restdocs.payload.JsonFieldType
An object (map).
Operation - Interface in org.springframework.restdocs.operation
Describes an operation performed on a RESTful service.
OperationPreprocessor - Interface in org.springframework.restdocs.operation.preprocess
An OperationPreprocessor processes the OperationRequest and OperationResponse of an Operation prior to it being documented.
OperationPreprocessorAdapter - Class in org.springframework.restdocs.operation.preprocess
An implementation of OperationPreprocessor that returns the request and response as-is.
OperationPreprocessorAdapter() - Constructor for class org.springframework.restdocs.operation.preprocess.OperationPreprocessorAdapter
 
operationPreprocessors() - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer
Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.
operationPreprocessors() - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer
 
operationPreprocessors() - Method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer
 
operationPreprocessors() - Method in class org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer
 
OperationPreprocessorsConfigurer<PARENT,TYPE> - Class in org.springframework.restdocs.config
A configurer that can be used to configure the default operation preprocessors.
OperationPreprocessorsConfigurer(PARENT) - Constructor for class org.springframework.restdocs.config.OperationPreprocessorsConfigurer
Creates a new OperationPreprocessorConfigurer with the given parent.
OperationRequest - Interface in org.springframework.restdocs.operation
The request that was sent as part of performing an operation on a RESTful service.
OperationRequestFactory - Class in org.springframework.restdocs.operation
A factory for creating OperationRequests.
OperationRequestFactory() - Constructor for class org.springframework.restdocs.operation.OperationRequestFactory
 
OperationRequestPart - Interface in org.springframework.restdocs.operation
A part of a multipart request.
OperationRequestPartFactory - Class in org.springframework.restdocs.operation
A factory for creating OperationRequestParts.
OperationRequestPartFactory() - Constructor for class org.springframework.restdocs.operation.OperationRequestPartFactory
 
OperationRequestPreprocessor - Interface in org.springframework.restdocs.operation.preprocess
An OperationRequestPreprocessor is used to modify an OperationRequest prior to it being documented.
OperationResponse - Interface in org.springframework.restdocs.operation
The response that was received as part of performing an operation on a RESTful service.
OperationResponseFactory - Class in org.springframework.restdocs.operation
A factory for creating OperationResponses.
OperationResponseFactory() - Constructor for class org.springframework.restdocs.operation.OperationResponseFactory
 
OperationResponsePreprocessor - Interface in org.springframework.restdocs.operation.preprocess
An OperationResponsePreprocessor is used to modify an OperationResponse prior to it being documented.
optional() - Method in class org.springframework.restdocs.cookies.CookieDescriptor
Marks the cookie as optional.
optional() - Method in class org.springframework.restdocs.headers.HeaderDescriptor
Marks the header as optional.
optional() - Method in class org.springframework.restdocs.hypermedia.LinkDescriptor
Marks the link as optional.
optional() - Method in class org.springframework.restdocs.payload.FieldDescriptor
Marks the field as optional.
optional() - Method in class org.springframework.restdocs.request.ParameterDescriptor
Marks the parameter as optional.
optional() - Method in class org.springframework.restdocs.request.RequestPartDescriptor
Marks the request part as optional.
options(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
Create a MockHttpServletRequestBuilder for an OPTIONS request.
options(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
Create a MockHttpServletRequestBuilder for an OPTIONS request.
org.springframework.restdocs - package org.springframework.restdocs
Core Spring REST Docs classes.
org.springframework.restdocs.cli - package org.springframework.restdocs.cli
Documenting CLI commands required to make a request to a RESTful API.
org.springframework.restdocs.config - package org.springframework.restdocs.config
Classes for configuring Spring REST Docs.
org.springframework.restdocs.constraints - package org.springframework.restdocs.constraints
Documenting a RESTful API's constraints.
org.springframework.restdocs.cookies - package org.springframework.restdocs.cookies
Documenting the cookies of a RESTful API's requests and responses.
org.springframework.restdocs.generate - package org.springframework.restdocs.generate
Classes that drive the generation of the documentation snippets.
org.springframework.restdocs.headers - package org.springframework.restdocs.headers
Documenting the headers of a RESTful API's requests and responses.
org.springframework.restdocs.http - package org.springframework.restdocs.http
Documenting the HTTP request sent to a RESTful API and the HTTP response that is returned.
org.springframework.restdocs.hypermedia - package org.springframework.restdocs.hypermedia
Documenting a RESTful API that uses hypermedia.
org.springframework.restdocs.mockmvc - package org.springframework.restdocs.mockmvc
Core classes for using Spring REST Docs with Spring Test's MockMvc.
org.springframework.restdocs.operation - package 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.operation.preprocess - package org.springframework.restdocs.operation.preprocess
Support for preprocessing an operation prior to it being documented.
org.springframework.restdocs.payload - package org.springframework.restdocs.payload
Documenting the payload of a RESTful API's requests and responses.
org.springframework.restdocs.request - package org.springframework.restdocs.request
Documenting query and path parameters of requests sent to a RESTful API.
org.springframework.restdocs.restassured - package org.springframework.restdocs.restassured
Core classes for using Spring REST Docs with REST Assured.
org.springframework.restdocs.snippet - package org.springframework.restdocs.snippet
Snippet generation.
org.springframework.restdocs.templates - package org.springframework.restdocs.templates
Template API used to render documentation snippets.
org.springframework.restdocs.templates.mustache - package org.springframework.restdocs.templates.mustache
JMustache-based implementation of the template API.
org.springframework.restdocs.webtestclient - package org.springframework.restdocs.webtestclient
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form