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

G

get(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a GET request.

get(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a GET request.

getAttributes() - Method in interface org.springframework.restdocs.operation.Operation

Returns a Map of attributes associated with the operation.

getAttributes() - Method in class org.springframework.restdocs.operation.StandardOperation

getAttributes() - Method in class org.springframework.restdocs.snippet.AbstractDescriptor

Returns the descriptor's attributes.

getAttributes() - Method in class org.springframework.restdocs.snippet.TemplatedSnippet

Returns the additional attributes that will be included in the model during template rendering.

getCompiler() - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Returns the Mustache.Compiler used to compile Mustache templates.

getConfiguration() - Method in class org.springframework.restdocs.constraints.Constraint

Returns the configuration of the constraint.

getConfiguration(FilterableRequestSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured.RestDocumentationFilter

Returns the configuration that should be used when calling the delgate.

getContent() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the content of the request.

getContent() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the contents of the part.

getContent() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the content of the response.

getContent(Operation) - Method in class org.springframework.restdocs.payload.AbstractBodySnippet

Returns the content of the request or response extracted from the given operation.

getContent(Operation) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the content of the request or response extracted form the given operation.

getContent(Operation) - Method in class org.springframework.restdocs.payload.RequestBodySnippet

getContent(Operation) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

getContent(Operation) - Method in class org.springframework.restdocs.payload.RequestPartBodySnippet

getContent(Operation) - Method in class org.springframework.restdocs.payload.RequestPartFieldsSnippet

getContent(Operation) - Method in class org.springframework.restdocs.payload.ResponseBodySnippet

getContent(Operation) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

getContentAsString() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the content of the request as a String.

getContentAsString() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the content of the part as a String.

getContentAsString() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the content of the response as a String.

getContentType(Operation) - Method in class org.springframework.restdocs.payload.AbstractBodySnippet

Returns the content type of the request or response extracted from the given operation.

getContentType(Operation) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the content type of the request or response extracted from the given operation.

getContentType(Operation) - Method in class org.springframework.restdocs.payload.RequestBodySnippet

getContentType(Operation) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

getContentType(Operation) - Method in class org.springframework.restdocs.payload.RequestPartBodySnippet

getContentType(Operation) - Method in class org.springframework.restdocs.payload.RequestPartFieldsSnippet

getContentType(Operation) - Method in class org.springframework.restdocs.payload.ResponseBodySnippet

getContentType(Operation) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

getContext() - Method in class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver

Returns the RestDocumentationContext that should be used during placeholder resolution.

getCookieDescriptors() - Method in class org.springframework.restdocs.cookies.AbstractCookiesSnippet

Returns the list of CookieDescriptors that will be used to generate the documentation.

getCookies() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the cookies sent with the request.

getCookies() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the cookies returned with the response.

getDelegate() - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler

Returns the RestDocumentationGenerator that is used as a delegate.

getDescription() - Method in class org.springframework.restdocs.snippet.AbstractDescriptor

Returns the description.

getDescriptorsByRel() - Method in class org.springframework.restdocs.hypermedia.LinksSnippet

Returns a Map of LinkDescriptors keyed by their rels.

getFieldDescriptors() - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the list of FieldDescriptors that will be used to generate the documentation.

getFieldPath() - Method in class org.springframework.restdocs.payload.FieldPathPayloadSubsectionExtractor

Returns the path of the field that will be extracted.

getFileExtension() - Method in interface org.springframework.restdocs.templates.TemplateFormat

Returns the file extension to use for files generated from templates in this format.

getHeaderDescriptors() - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet

Returns the list of HeaderDescriptors that will be used to generate the documentation.

getHeaders() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the headers that were included in the request.

getHeaders() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the part's headers.

getHeaders() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the headers in the response.

getHref() - Method in class org.springframework.restdocs.hypermedia.Link

Returns the link's href.

getId() - Method in interface org.springframework.restdocs.templates.TemplateFormat

Returns the id of this template format.

getKey() - Method in class org.springframework.restdocs.snippet.Attributes.Attribute

Returns the attribute's key.

getMethod() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the HTTP method of the request.

getName() - Method in class org.springframework.restdocs.constraints.Constraint

Returns the name of the constraint.

getName() - Method in class org.springframework.restdocs.cookies.CookieDescriptor

Returns the name for the cookie.

getName() - Method in class org.springframework.restdocs.headers.HeaderDescriptor

Returns the name for the header.

getName() - Method in interface org.springframework.restdocs.operation.Operation

Returns the name of the operation.

getName() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the name of the part.

getName() - Method in class org.springframework.restdocs.operation.RequestCookie

Returns the name of the cookie.

getName() - Method in class org.springframework.restdocs.operation.ResponseCookie

Returns the name of the cookie.

getName() - Method in class org.springframework.restdocs.operation.StandardOperation

getName() - Method in class org.springframework.restdocs.request.ParameterDescriptor

Returns the name of the parameter being described by this descriptor.

getName() - Method in class org.springframework.restdocs.request.RequestPartDescriptor

Returns the name of the request part being described by this descriptor.

getOutputDirectory() - Method in interface org.springframework.restdocs.RestDocumentationContext

Returns the output directory to which generated snippets should be written.

getParameterDescriptors() - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

Returns a Map of ParameterDescriptors that will be used to generate the documentation key by their ParameterDescriptor.getName().

getParts() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the request's parts, provided that it is a multipart request.

getPath() - Method in class org.springframework.restdocs.payload.FieldDescriptor

Returns the path of the field described by this descriptor.

getRel() - Method in class org.springframework.restdocs.hypermedia.Link

Returns the link's rel.

getRel() - Method in class org.springframework.restdocs.hypermedia.LinkDescriptor

Returns the rel of the link described by this descriptor.

getRequest() - Method in interface org.springframework.restdocs.operation.Operation

Returns the request that was sent.

getRequest() - Method in class org.springframework.restdocs.operation.StandardOperation

getResponse() - Method in interface org.springframework.restdocs.operation.Operation

Returns the response that was received.

getResponse() - Method in class org.springframework.restdocs.operation.StandardOperation

getSnippetName() - Method in class org.springframework.restdocs.snippet.TemplatedSnippet

Returns the name of the snippet that will be created.

getStatus() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the status of the response.

getStepCount() - Method in interface org.springframework.restdocs.RestDocumentationContext

Returns the current step count.

getSubmittedFileName() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the name of the file that is being uploaded in this part.

getSubsectionExtractor() - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the PayloadSubsectionExtractor, if any, used by this snippet.

getSubsectionId() - Method in class org.springframework.restdocs.payload.FieldPathPayloadSubsectionExtractor

getSubsectionId() - Method in interface org.springframework.restdocs.payload.PayloadSubsectionExtractor

Returns an identifier for the subsection that this extractor will extract.

getTemplateResourceResolver() - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Returns the TemplateResourceResolver used to resolve the template resources prior to compilation.

getTestClass() - Method in interface org.springframework.restdocs.RestDocumentationContext

Returns the class whose tests are currently executing.

getTestMethodName() - Method in interface org.springframework.restdocs.RestDocumentationContext

Returns the name of the test method that is currently executing.

getTitle() - Method in class org.springframework.restdocs.hypermedia.Link

Returns the link's title, or null if it does not have a title.

getType() - Method in class org.springframework.restdocs.payload.FieldDescriptor

Returns the type of the field described by this descriptor.

getUri() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the request's URI.

getValue() - Method in class org.springframework.restdocs.operation.RequestCookie

Returns the value of the cookie.

getValue() - Method in class org.springframework.restdocs.operation.ResponseCookie

Returns the value of the cookie.

getValue() - Method in class org.springframework.restdocs.snippet.Attributes.Attribute

Returns the attribute's value.

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