Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Provide an API for configuring additional default snippets

Browse Source 
Previously, the default snippets could only be configured by
replacing those that are configured out of the box. This commit adds
a method, withAdditionalDefaults, that can be used to add one or more
snippets to those that are configured out of the box.

Closes gh-237
This commit is contained in:
Andy Wilkinson
2016-05-23 15:48:50 +01:00
parent 1c04ddc7e5
commit 117e8ec096
2 changed files with 40 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
spring-restdocs-core/src/main/java/org/springframework/restdocs/config/SnippetConfigurer.java
View File

@@ -16,6 +16,7 @@
package org.springframework.restdocs.config;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
@@ -38,9 +39,9 @@ import org.springframework.restdocs.templates.TemplateFormats;
public abstract class SnippetConfigurer<PARENT, TYPE>
extends AbstractNestedConfigurer<PARENT> {
private List<Snippet> defaultSnippets = Arrays.asList(CliDocumentation.curlRequest(),
CliDocumentation.httpieRequest(), HttpDocumentation.httpRequest(),
HttpDocumentation.httpResponse());
private List<Snippet> defaultSnippets = new ArrayList<>(Arrays.asList(
CliDocumentation.curlRequest(), CliDocumentation.httpieRequest(),
HttpDocumentation.httpRequest(), HttpDocumentation.httpResponse()));
/**
* The default encoding for documentation snippets.
@@ -97,10 +98,24 @@ public abstract class SnippetConfigurer<PARENT, TYPE>
*
* @param defaultSnippets the default snippets
* @return {@code this}
* @see #withAdditionalDefaults(Snippet...)
*/
@SuppressWarnings("unchecked")
public TYPE withDefaults(Snippet... defaultSnippets) {
this.defaultSnippets = Arrays.asList(defaultSnippets);
this.defaultSnippets = new ArrayList<>(Arrays.asList(defaultSnippets));
return (TYPE) this;
}
/**
* Configures additional documentation snippets that will be produced by default.
*
* @param additionalDefaultSnippets the additional default snippets
* @return {@code this}
* @see #withDefaults(Snippet...)
*/
@SuppressWarnings("unchecked")
public TYPE withAdditionalDefaults(Snippet... additionalDefaultSnippets) {
this.defaultSnippets.addAll(Arrays.asList(additionalDefaultSnippets));
return (TYPE) this;
}

22
spring-restdocs-core/src/test/java/org/springframework/restdocs/config/RestDocumentationConfigurerTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2016 the original author or authors.
* Copyright 2014-2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -119,6 +119,26 @@ public class RestDocumentationConfigurerTests {
assertThat(defaultSnippets, contains(instanceOf(CurlRequestSnippet.class)));
}
@SuppressWarnings("unchecked")
@Test
public void additionalDefaultSnippets() {
Map<String, Object> configuration = new HashMap<>();
Snippet snippet = mock(Snippet.class);
this.configurer.snippets().withAdditionalDefaults(snippet).apply(configuration,
createContext());
assertThat(configuration,
hasEntry(
equalTo(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_SNIPPETS),
instanceOf(List.class)));
List<Snippet> defaultSnippets = (List<Snippet>) configuration
.get(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_SNIPPETS);
assertThat(defaultSnippets,
contains(instanceOf(CurlRequestSnippet.class),
instanceOf(HttpieRequestSnippet.class),
instanceOf(HttpRequestSnippet.class),
instanceOf(HttpResponseSnippet.class), equalTo(snippet)));
}
@Test
public void customSnippetEncoding() {
Map<String, Object> configuration = new HashMap<>();