Deprecated API

Contents

• Deprecated Packages
• Deprecated Classes
• Deprecated Methods
• Deprecated Constructors

Deprecated Packages

Package and Description
org.springframework.restdocs.curl Since 1.1 in favor of functionality in org.springframework.restdocs.cli

Deprecated Classes

Class and Description
org.springframework.restdocs.curl.CurlDocumentation Since 1.1 in favor of CliDocumentation.
org.springframework.restdocs.curl.CurlRequestSnippet Since 1.1 in favor of CurlRequestSnippet.
org.springframework.restdocs.cli.QueryStringParser since 1.1.2 in favor of QueryStringParser
org.springframework.restdocs.RestDocumentation Since 1.1 in favor of JUnitRestDocumentation

Deprecated Methods

Method and Description
org.springframework.restdocs.generate.RestDocumentationGenerator.addSnippets(Snippet...) since 1.1 in favor of RestDocumentationGenerator.withSnippets(Snippet...)
org.springframework.restdocs.curl.CurlDocumentation.curlRequest() Since 1.1 in favor of CliDocumentation.curlRequest().
org.springframework.restdocs.curl.CurlDocumentation.curlRequest(Map<String, Object>) Since 1.1 in favor of CliDocumentation.curlRequest(Map).
org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration(RestDocumentation) Since 1.1 in favor of MockMvcRestDocumentation.documentationConfiguration(RestDocumentationContextProvider)
org.springframework.restdocs.request.AbstractParametersSnippet.getFieldDescriptors() since 1.1.0 in favor of AbstractParametersSnippet.getParameterDescriptors()
org.springframework.restdocs.snippet.WriterResolver.setEncoding(String) since 1.1.0 in favour of configuring the encoding when to resolver is created
org.springframework.restdocs.snippet.StandardWriterResolver.setEncoding(String)
org.springframework.restdocs.mockmvc.RestDocumentationResultHandler.snippets(Snippet...) since 1.1 in favor of RestDocumentationResultHandler.document(Snippet...) and passing the return value into ResultActions.andDo(ResultHandler)
org.springframework.restdocs.restassured.RestDocumentationFilter.snippets(Snippet...) since 1.1 in favor of document(Snippet...)

Deprecated Constructors

Constructor and Description
org.springframework.restdocs.payload.AbstractFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>) since 1.1 in favor of AbstractFieldsSnippet.AbstractFieldsSnippet(String, List, Map, boolean)
org.springframework.restdocs.request.AbstractParametersSnippet(String, List<ParameterDescriptor>, Map<String, Object>) since 1.1 in favour of AbstractParametersSnippet.AbstractParametersSnippet(String, List, Map, boolean)
org.springframework.restdocs.curl.CurlRequestSnippet() Since 1.1 in favor of CurlRequestSnippet.
org.springframework.restdocs.curl.CurlRequestSnippet(Map<String, Object>) Since 1.1 in favor of CurlRequestSnippet.
org.springframework.restdocs.RestDocumentationContext(Class<?>, String, File) Since 1.1 in favor of ManualRestDocumentation.
org.springframework.restdocs.templates.StandardTemplateResourceResolver() since 1.1.0 in favour of StandardTemplateResourceResolver.StandardTemplateResourceResolver(TemplateFormat)
org.springframework.restdocs.snippet.StandardWriterResolver(PropertyPlaceholderHelper.PlaceholderResolver) since 1.1.0 in favor of StandardWriterResolver.StandardWriterResolver(PlaceholderResolverFactory, String, TemplateFormat)