Index (spring-restdocs 1.0.0.M1 API)

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

A

afterTestMethod(TestContext) - Method in class org.springframework.restdocs.config.RestDocumentationTestExecutionListener
and() - Method in interface org.springframework.restdocs.config.NestedConfigurer: Returns the configurer's parent
andDocument(String) - Method in class org.springframework.restdocs.ResponseModifier: Provides a RestDocumentationResultHandler that can be used to document the request and modified result.
AsciidoctorWriter - Class in org.springframework.restdocs.snippet: A DocumentationWriter that produces output in Asciidoctor.
AsciidoctorWriter(Writer) - Constructor for class org.springframework.restdocs.snippet.AsciidoctorWriter: Creates a new AsciidoctorWriter that will write to the given writer
atomLinks() - Static method in class org.springframework.restdocs.hypermedia.LinkExtractors: Returns a LinkExtractor capable of extracting links in Atom format where the links are found in an array named links.

B

beforeMockMvcCreated(ConfigurableMockMvcBuilder<?>, WebApplicationContext) - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer
beforeTestMethod(TestContext) - Method in class org.springframework.restdocs.config.RestDocumentationTestExecutionListener

C

codeBlock(String, DocumentationWriter.DocumentationAction) - Method in class org.springframework.restdocs.snippet.AsciidoctorWriter
codeBlock(String, DocumentationWriter.DocumentationAction) - Method in class org.springframework.restdocs.snippet.DocumentationWriter: Calls the given action to document a code block.
ContentModifyingReponsePostProcessor - Class in org.springframework.restdocs.response: A base class for ResponsePostProcessors that modify the content of the response.
ContentModifyingReponsePostProcessor() - Constructor for class org.springframework.restdocs.response.ContentModifyingReponsePostProcessor
CurlDocumentation - Class in org.springframework.restdocs.curl: Static factory methods for documenting a RESTful API as if it were being driven using the cURL command-line utility.
currentContext() - Static method in class org.springframework.restdocs.config.RestDocumentationContext: Returns the current context, never null.

D

DEFAULT_CONTEXT_PATH - Static variable in class org.springframework.restdocs.config.UriConfigurer: The default context path for documented URIs
DEFAULT_HOST - Static variable in class org.springframework.restdocs.config.UriConfigurer: The defalt host for documented URIs
DEFAULT_PORT - Static variable in class org.springframework.restdocs.config.UriConfigurer: The default port for documented URIs
DEFAULT_SCHEME - Static variable in class org.springframework.restdocs.config.UriConfigurer: The default scheme for documented URIs
DEFAULT_SNIPPET_ENCODING - Static variable in class org.springframework.restdocs.config.SnippetConfigurer: The default encoding for documentation snippets
description(String) - Method in class org.springframework.restdocs.hypermedia.LinkDescriptor: Specifies the description of the link
description(String) - Method in class org.springframework.restdocs.payload.FieldDescriptor: Specifies the description of the field
description(String) - Method in class org.springframework.restdocs.request.ParameterDescriptor: Specifies the description of the parameter
document(String) - Static method in class org.springframework.restdocs.RestDocumentation: Documents the API call to the given outputDir.
DocumentableHttpServletRequest - Class in org.springframework.restdocs.util: An HttpServletRequest wrapper that provides a limited set of methods intended to help in the documentation of the request.
DocumentableHttpServletRequest(MockHttpServletRequest) - Constructor for class org.springframework.restdocs.util.DocumentableHttpServletRequest: Creates a new DocumentableHttpServletRequest to document the given request.
documentationConfiguration() - Static method in class org.springframework.restdocs.RestDocumentation: Provides access to a MockMvcConfigurer that can be used to configure the REST documentation when building a MockMvc instance.
DocumentationWriter - Class in org.springframework.restdocs.snippet: A PrintWriter that provides additional methods which are useful for producing API documentation.
DocumentationWriter(Writer) - Constructor for class org.springframework.restdocs.snippet.DocumentationWriter
DocumentationWriter.DocumentationAction - Interface in org.springframework.restdocs.snippet: Encapsulates an action that outputs some documentation.
DocumentationWriter.TableAction - Interface in org.springframework.restdocs.snippet: Encapsulates an action that outputs a table.
DocumentationWriter.TableWriter - Interface in org.springframework.restdocs.snippet: A writer for producing a table
documentCurlRequest(String) - Static method in class org.springframework.restdocs.curl.CurlDocumentation: Produces a documentation snippet containing the request formatted as a cURL command
documentHttpRequest(String) - Static method in class org.springframework.restdocs.http.HttpDocumentation: Produces a documentation snippet containing the request formatted as an HTTP request
documentHttpResponse(String) - Static method in class org.springframework.restdocs.http.HttpDocumentation: Produces a documentation snippet containing the response formatted as the HTTP response sent by the server
documentLinks(String, LinkExtractor, LinkDescriptor...) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation: Creates a LinkSnippetResultHandler that will produce a documentation snippet for a response's links.
documentQueryParameters(String, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Creates a SnippetWritingResultHandler that will produce a snippet documenting a request's query parameters
documentRequestFields(String, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation: Creates a RequestFieldsSnippetResultHandler that will produce a documentation snippet for a request's fields.
documentResponseFields(String, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation: Creates a ResponseFieldsSnippetResultHandler that will produce a documentation snippet for a response's fields.

E

equals(Object) - Method in class org.springframework.restdocs.hypermedia.Link
extractLinks(MockHttpServletResponse) - Method in interface org.springframework.restdocs.hypermedia.LinkExtractor: Extract the links from the given response, returning a Map of links where the keys are the link rels.
extractorForContentType(String) - Static method in class org.springframework.restdocs.hypermedia.LinkExtractors: Returns the LinkExtractor for the given contentType or null if there is no extractor for the content type.

F

FieldDescriptor - Class in org.springframework.restdocs.payload: A description of a field found in a request or response payload
FieldSnippetResultHandler - Class in org.springframework.restdocs.payload: A SnippetWritingResultHandler that produces a snippet documenting a RESTful resource's request or response fields.
FieldType - Enum in org.springframework.restdocs.payload: An enumeration of the possible types for a field in a JSON request or response payload
fieldWithPath(String) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation: Creates a FieldDescriptor that describes a field with the given path.

G

getContentAsString() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns a String of the request's content
getContentLength() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the length of the request's content
getContextPath() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the request's context path
getHeaders() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the request's headers.
getHost() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the name of the host to which the request was sent.
getHref() - Method in class org.springframework.restdocs.hypermedia.Link: Returns the link's href
getMethod() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the request's method.
getParameterMapAsQueryString() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the request's parameter map formatted as a query string
getPayloadReader(MvcResult) - Method in class org.springframework.restdocs.payload.FieldSnippetResultHandler
getPayloadReader(MvcResult) - Method in class org.springframework.restdocs.payload.RequestFieldSnippetResultHandler
getPayloadReader(MvcResult) - Method in class org.springframework.restdocs.payload.ResponseFieldSnippetResultHandler
getPort() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the port to which the request was sent.
getRel() - Method in class org.springframework.restdocs.hypermedia.Link: Returns the link's rel
getRequestUriWithQueryString() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the request's URI including its query string.
getScheme() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Returns the request's scheme.
getSnippetEncoding() - Method in class org.springframework.restdocs.config.RestDocumentationContext: Gets the encoding to be used when writing snippets
getStepCount() - Method in class org.springframework.restdocs.config.RestDocumentationContext: Gets the current step count
getTestMethod() - Method in class org.springframework.restdocs.config.RestDocumentationContext: Returns the test method that is currently executing

H

halLinks() - Static method in class org.springframework.restdocs.hypermedia.LinkExtractors: Returns a LinkExtractor capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named _links.
handle(MvcResult, DocumentationWriter) - Method in class org.springframework.restdocs.hypermedia.LinkSnippetResultHandler
handle(MvcResult, DocumentationWriter) - Method in class org.springframework.restdocs.payload.FieldSnippetResultHandler
handle(MvcResult, DocumentationWriter) - Method in class org.springframework.restdocs.request.QueryParametersSnippetResultHandler
handle(MvcResult) - Method in class org.springframework.restdocs.RestDocumentationResultHandler
handle(MvcResult, DocumentationWriter) - Method in class org.springframework.restdocs.snippet.SnippetWritingResultHandler
handle(MvcResult) - Method in class org.springframework.restdocs.snippet.SnippetWritingResultHandler
hashCode() - Method in class org.springframework.restdocs.hypermedia.Link
headers(String...) - Method in interface org.springframework.restdocs.snippet.DocumentationWriter.TableWriter: Writes the table's headers
HttpDocumentation - Class in org.springframework.restdocs.http: Static factory methods for documenting a RESTful API's HTTP requests.
HypermediaDocumentation - Class in org.springframework.restdocs.hypermedia: Static factory methods for documenting a RESTful API that utilises Hypermedia.

I

isGetRequest() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Whether or not this request is a GET request.
isPostRequest() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Whether or not this request is a POST request.
isPutRequest() - Method in class org.springframework.restdocs.util.DocumentableHttpServletRequest: Whether or not this request is a PUT request.
iterable(Enumeration<T>) - Static method in class org.springframework.restdocs.util.IterableEnumeration: Creates a new Iterable that will iterate over the given enumeration
IterableEnumeration<T> - Class in org.springframework.restdocs.util: An adapter to expose an Enumeration as an Iterable.
iterator() - Method in class org.springframework.restdocs.util.IterableEnumeration

L

Link - Class in org.springframework.restdocs.hypermedia: Representation of a link used in a Hypermedia-based API
Link(String, String) - Constructor for class org.springframework.restdocs.hypermedia.Link: Creates a new Link with the given rel and href
LinkDescriptor - Class in org.springframework.restdocs.hypermedia: A description of a link found in a hypermedia API
LinkExtractor - Interface in org.springframework.restdocs.hypermedia: A LinkExtractor is used to extract links from a JSON response.
LinkExtractors - Class in org.springframework.restdocs.hypermedia: Static factory methods providing a selection of link extractors for use when documentating a hypermedia-based API.
LinkSnippetResultHandler - Class in org.springframework.restdocs.hypermedia: A SnippetWritingResultHandler that produces a snippet documenting a RESTful resource's links.
linkWithRel(String) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation: Creates a LinkDescriptor that describes a link with the given rel.

M

maskLinks() - Static method in class org.springframework.restdocs.response.ResponsePostProcessors: Returns a ResponsePostProcessor that will update the content of the response to mask any links that it contains.
maskLinksWith(String) - Static method in class org.springframework.restdocs.response.ResponsePostProcessors: Returns a ResponsePostProcessor that will update the content of the response to mask any links that it contains.
modifyContent(String) - Method in class org.springframework.restdocs.response.ContentModifyingReponsePostProcessor: Returns a modified version of the given originalContent
modifyResponseTo(ResponsePostProcessor...) - Static method in class org.springframework.restdocs.RestDocumentation: Enables the modification of the response in a MvcResult prior to it being documented.

N

NestedConfigurer<PARENT extends MockMvcConfigurer> - Interface in org.springframework.restdocs.config: A configurer that is nested and, therefore, has a parent.

O

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
org.springframework.restdocs - package org.springframework.restdocs
org.springframework.restdocs.config - package org.springframework.restdocs.config
org.springframework.restdocs.curl - package org.springframework.restdocs.curl
org.springframework.restdocs.http - package org.springframework.restdocs.http
org.springframework.restdocs.hypermedia - package org.springframework.restdocs.hypermedia
org.springframework.restdocs.payload - package org.springframework.restdocs.payload
org.springframework.restdocs.request - package org.springframework.restdocs.request
org.springframework.restdocs.response - package org.springframework.restdocs.response
org.springframework.restdocs.snippet - package org.springframework.restdocs.snippet
org.springframework.restdocs.util - package org.springframework.restdocs.util

P

ParameterDescriptor - Class in org.springframework.restdocs.request: A descriptor of a parameter in a query string
parameterWithName(String) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Creates a ParameterDescriptor that describes a query string parameter with the given name.
PayloadDocumentation - Class in org.springframework.restdocs.payload: Static factory methods for documenting a RESTful API's request and response payloads.
perform() - Method in interface org.springframework.restdocs.snippet.DocumentationWriter.DocumentationAction: Perform the encapsulated action
perform(DocumentationWriter.TableWriter) - Method in interface org.springframework.restdocs.snippet.DocumentationWriter.TableAction: Perform the encapsulated action
postProcess(MockHttpServletResponse) - Method in class org.springframework.restdocs.response.ContentModifyingReponsePostProcessor
postProcess(MockHttpServletResponse) - Method in interface org.springframework.restdocs.response.ResponsePostProcessor: Post-processes the given response, returning a, possibly new, MockHttpServletResponse that should now be used.
prettyPrintContent() - Static method in class org.springframework.restdocs.response.ResponsePostProcessors: Returns a ResponsePostProcessor that will pretty print the content of the response.

Q

QueryParametersSnippetResultHandler - Class in org.springframework.restdocs.request: A SnippetWritingResultHandler that produces a snippet documenting the query parameters supported by a RESTful resource.
QueryParametersSnippetResultHandler(String, ParameterDescriptor...) - Constructor for class org.springframework.restdocs.request.QueryParametersSnippetResultHandler

R

removeHeaders(String...) - Static method in class org.springframework.restdocs.response.ResponsePostProcessors: Returns a ResponsePostProcessor that will remove the headers with the given headerNames from the response.
replacePattern(Pattern, String) - Static method in class org.springframework.restdocs.response.ResponsePostProcessors: Returns a ResponsePostProcessor that will update the content of the response by replacing any occurrences of the given pattern with the given replacement.
RequestDocumentation - Class in org.springframework.restdocs.request: Static factory methods for documenting aspects of a request sent to a RESTful API.
RequestFieldSnippetResultHandler - Class in org.springframework.restdocs.payload: A FieldSnippetResultHandler for documenting a request's fields
ResponseFieldSnippetResultHandler - Class in org.springframework.restdocs.payload: A FieldSnippetResultHandler for documenting a response's fields
ResponseModifier - Class in org.springframework.restdocs: Modifies the response in an MvcResult by applying ResponsePostProcessors to it.
ResponsePostProcessor - Interface in org.springframework.restdocs.response: A ResponsePostProcessor is used to modify the response received from a MockMvc call prior to the response being documented.
ResponsePostProcessors - Class in org.springframework.restdocs.response: Static factory methods for accessing various ResponsePostProcessors.
RestDocumentation - Class in org.springframework.restdocs: Static factory methods for documenting RESTful APIs using Spring MVC Test
RestDocumentationConfigurer - Class in org.springframework.restdocs.config: A MockMvcConfigurer that can be used to configure the documentation
RestDocumentationConfigurer() - Constructor for class org.springframework.restdocs.config.RestDocumentationConfigurer: Creates a new RestDocumentationConfigurer.
RestDocumentationContext - Class in org.springframework.restdocs.config: RestDocumentationContext encapsulates the context in which the documentation of a RESTful API is being performed.
RestDocumentationResultHandler - Class in org.springframework.restdocs: A Spring MVC Test ResultHandler for documenting RESTful APIs.
RestDocumentationTestExecutionListener - Class in org.springframework.restdocs.config: A TestExecutionListener that sets up and tears down the Spring REST Docs context for each test method
RestDocumentationTestExecutionListener() - Constructor for class org.springframework.restdocs.config.RestDocumentationTestExecutionListener
row(String...) - Method in interface org.springframework.restdocs.snippet.DocumentationWriter.TableWriter: Writes a row in the table

S

shellCommand(DocumentationWriter.DocumentationAction) - Method in class org.springframework.restdocs.snippet.AsciidoctorWriter
shellCommand(DocumentationWriter.DocumentationAction) - Method in class org.springframework.restdocs.snippet.DocumentationWriter: Calls the given action to document a shell command.
SnippetConfigurer - Class in org.springframework.restdocs.config: A configurer that can be used to configure the generated documentation snippets.
SnippetGenerationException - Exception in org.springframework.restdocs.snippet: A RuntimeException thrown to indicate a problem with the generation of a documentation snippet.
SnippetGenerationException(String) - Constructor for exception org.springframework.restdocs.snippet.SnippetGenerationException: Creates a new SnippetGenerationException described by the given message
snippets() - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer
SnippetWritingResultHandler - Class in org.springframework.restdocs.snippet: Base class for a ResultHandler that writes a documentation snippet
SnippetWritingResultHandler(String, String) - Constructor for class org.springframework.restdocs.snippet.SnippetWritingResultHandler

T

table(DocumentationWriter.TableAction) - Method in class org.springframework.restdocs.snippet.AsciidoctorWriter
table(DocumentationWriter.TableAction) - Method in class org.springframework.restdocs.snippet.DocumentationWriter: Calls the given action to document a table.
toString() - Method in class org.springframework.restdocs.hypermedia.Link
toString() - Method in enum org.springframework.restdocs.payload.FieldType
type(FieldType) - Method in class org.springframework.restdocs.payload.FieldDescriptor: Specifies the type of the field

U

UriConfigurer - Class in org.springframework.restdocs.config: A configurer that can be used to configure the documented URIs
UriConfigurer(RestDocumentationConfigurer) - Constructor for class org.springframework.restdocs.config.UriConfigurer
uris() - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer

V

valueOf(String) - Static method in enum org.springframework.restdocs.payload.FieldType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.restdocs.payload.FieldType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withContextPath(String) - Method in class org.springframework.restdocs.config.UriConfigurer: Configures any documented URIs to use the given contextPath.
withEncoding(String) - Method in class org.springframework.restdocs.config.SnippetConfigurer: Configures any documentation snippets to be written using the given encoding.
withHost(String) - Method in class org.springframework.restdocs.config.UriConfigurer: Configures any documented URIs to use the given host.
withLinks(LinkDescriptor...) - Method in class org.springframework.restdocs.RestDocumentationResultHandler: Document the links in the response using the given descriptors.
withLinks(LinkExtractor, LinkDescriptor...) - Method in class org.springframework.restdocs.RestDocumentationResultHandler: Document the links in the response using the given descriptors.
withPort(int) - Method in class org.springframework.restdocs.config.UriConfigurer: Configures any documented URIs to use the given port.
withQueryParameters(ParameterDescriptor...) - Method in class org.springframework.restdocs.RestDocumentationResultHandler: Documents the parameters in the request's query string using the given descriptors.
withRequestFields(FieldDescriptor...) - Method in class org.springframework.restdocs.RestDocumentationResultHandler: Document the fields in the request using the given descriptors.
withResponseFields(FieldDescriptor...) - Method in class org.springframework.restdocs.RestDocumentationResultHandler: Document the fields in the response using the given descriptors.
withScheme(String) - Method in class org.springframework.restdocs.config.UriConfigurer: Configures any documented URIs to use the given scheme.

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