A B C D E F G H I J K L M O P R S T U V W

O

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.

OperationRequest - Interface in org.springframework.restdocs.operation

The request that was sent as part of performing an operation on a RESTful service.

OperationRequestPart - Interface in org.springframework.restdocs.operation

A part of a multipart request

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.

OperationResponsePreprocessor - Interface in org.springframework.restdocs.operation.preprocess

An OperationRequestPreprocessor is used to modify an OperationRequest prior to it being documented.

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

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.constraints - package org.springframework.restdocs.constraints

Documenting a RESTful API's constraints.

org.springframework.restdocs.curl - package org.springframework.restdocs.curl

Documenting the curl command required to make a request to a RESTful API.

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.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.

A B C D E F G H I J K L M O P R S T U V W