- compileTemplate(String) - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine
-
- compileTemplate(String) - Method in interface org.springframework.restdocs.templates.TemplateEngine
-
Compiles the template at the given path.
- Constraint - Class in org.springframework.restdocs.constraints
-
A constraint
- Constraint(String, Map<String, Object>) - Constructor for class org.springframework.restdocs.constraints.Constraint
-
Creates a new Constraint with the given name and
configuration.
- ConstraintDescriptionResolver - Interface in org.springframework.restdocs.constraints
-
- ConstraintDescriptions - Class in org.springframework.restdocs.constraints
-
Provides access to descriptions of a class's constraints
- ConstraintDescriptions(Class<?>) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions
-
Create a new ConstraintDescriptions for the given clazz.
- ConstraintDescriptions(Class<?>, ConstraintResolver) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions
-
Create a new ConstraintDescriptions for the given clazz.
- ConstraintDescriptions(Class<?>, ConstraintDescriptionResolver) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions
-
Create a new ConstraintDescriptions for the given clazz.
- ConstraintDescriptions(Class<?>, ConstraintResolver, ConstraintDescriptionResolver) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions
-
Create a new ConstraintDescriptions for the given clazz.
- ConstraintResolver - Interface in org.springframework.restdocs.constraints
-
An abstraction for resolving a class's constraints.
- createModel(Operation) - Method in class org.springframework.restdocs.curl.CurlRequestSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.http.HttpRequestSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.http.HttpResponseSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.request.AbstractParametersSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.request.PathParametersSnippet
-
- createModel(Operation) - Method in class org.springframework.restdocs.snippet.TemplatedSnippet
-
Create the model that should be used during template rendering to document the
given operation.
- createModelForDescriptor(LinkDescriptor) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet
-
Returns a model for the given descriptor
- createModelForDescriptor(FieldDescriptor) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
Returns a model for the given descriptor
- createModelForDescriptor(ParameterDescriptor) - Method in class org.springframework.restdocs.request.AbstractParametersSnippet
-
Returns a model for the given descriptor.
- 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.
- curlRequest() - Static method in class org.springframework.restdocs.curl.CurlDocumentation
-
Returns a handler that will produce a snippet containing the curl request for the
API call.
- curlRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.curl.CurlDocumentation
-
Returns a handler that will produce a snippet containing the curl request for the
API call.
- CurlRequestSnippet - Class in org.springframework.restdocs.curl
-
A
Snippet that documents the curl command for a request.
- CurlRequestSnippet() - Constructor for class org.springframework.restdocs.curl.CurlRequestSnippet
-
Creates a new CurlRequestSnippet with no additional attributes.
- CurlRequestSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.curl.CurlRequestSnippet
-
Creates a new CurlRequestSnippet with the given additional
attributes that will be included in the model during template rendering.