Add support for documenting body of a request, response or request part

Closes gh-318
Closes gh-319
This commit is contained in:
Andy Wilkinson
2016-10-31 12:46:36 +00:00
parent 1393182182
commit dec3727da1
31 changed files with 1160 additions and 95 deletions

View File

@@ -25,6 +25,7 @@ import org.springframework.restdocs.RestDocumentationContext;
import org.springframework.restdocs.cli.CliDocumentation;
import org.springframework.restdocs.generate.RestDocumentationGenerator;
import org.springframework.restdocs.http.HttpDocumentation;
import org.springframework.restdocs.payload.PayloadDocumentation;
import org.springframework.restdocs.snippet.Snippet;
import org.springframework.restdocs.templates.TemplateFormat;
import org.springframework.restdocs.templates.TemplateFormats;
@@ -42,7 +43,8 @@ public abstract class SnippetConfigurer<PARENT, TYPE>
private List<Snippet> defaultSnippets = new ArrayList<>(Arrays.asList(
CliDocumentation.curlRequest(), CliDocumentation.httpieRequest(),
HttpDocumentation.httpRequest(), HttpDocumentation.httpResponse()));
HttpDocumentation.httpRequest(), HttpDocumentation.httpResponse(),
PayloadDocumentation.requestBody(), PayloadDocumentation.responseBody()));
/**
* The default encoding for documentation snippets.

View File

@@ -0,0 +1,125 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;
import org.springframework.http.MediaType;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.snippet.ModelCreationException;
import org.springframework.restdocs.snippet.TemplatedSnippet;
/**
* Abstract {@link TemplatedSnippet} subclass that provides a base for snippets that
* document a RESTful resource's request or response body.
*
* @author Andy Wilkinson
*/
public abstract class AbstractBodySnippet extends TemplatedSnippet {
private final PayloadSubsectionExtractor<?> subsectionExtractor;
/**
* Creates a new {@code AbstractBodySnippet} that will produce a snippet named
* {@code <type>-body} using a template named {@code <type>-body}. The snippet will
* contain the subsection of the body extracted by the given
* {@code subsectionExtractor}. The given {@code attributes} will be included in the
* model during template rendering
*
* @param type the type of the body
* @param subsectionExtractor the subsection extractor
* @param attributes the attributes
*/
protected AbstractBodySnippet(String type,
PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
this(type, type, subsectionExtractor, attributes);
}
/**
* Creates a new {@code AbstractBodySnippet} that will produce a snippet named
* {@code <name>-body} using a template named {@code <type>-body}. The snippet will
* contain the subsection of the body extracted by the given
* {@code subsectionExtractor}. The given {@code attributes} will be included in the
* model during template rendering
*
* @param name the name of the snippet
* @param type the type of the body
* @param subsectionExtractor the subsection extractor
* @param attributes the attributes
*/
protected AbstractBodySnippet(String name, String type,
PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
super(name + "-body"
+ (subsectionExtractor != null
? "-" + subsectionExtractor.getSubsectionId() : ""),
type + "-body", attributes);
this.subsectionExtractor = subsectionExtractor;
}
@Override
protected Map<String, Object> createModel(Operation operation) {
try {
MediaType contentType = getContentType(operation);
byte[] content = getContent(operation);
if (this.subsectionExtractor != null) {
content = this.subsectionExtractor.extractSubsection(content,
contentType);
}
Charset charset = extractCharset(contentType);
String body = charset != null ? new String(content, charset)
: new String(content);
Map<String, Object> model = new HashMap<>();
model.put("body", body);
return model;
}
catch (IOException ex) {
throw new ModelCreationException(ex);
}
}
private Charset extractCharset(MediaType contentType) {
if (contentType == null) {
return null;
}
return contentType.getCharset();
}
/**
* Returns the content of the request or response extracted from the given
* {@code operation}.
*
* @param operation The operation
* @return The content
* @throws IOException if the content cannot be extracted
*/
protected abstract byte[] getContent(Operation operation) throws IOException;
/**
* Returns the content type of the request or response extracted from the given
* {@code operation}.
*
* @param operation The operation
* @return The content type
*/
protected abstract MediaType getContentType(Operation operation);
}

View File

@@ -1443,6 +1443,164 @@ public abstract class PayloadDocumentation {
true);
}
/**
* Returns a {@code Snippet} that will document the body of the API operation's
* request payload.
*
* @return the snippet that will document the request body
*/
public static RequestBodySnippet requestBody() {
return new RequestBodySnippet();
}
/**
* Returns a {@code Snippet} that will document the body of the API operation's
* request payload. The given attributes will be made available during snippet
* generation.
*
* @param attributes the attributes
* @return the snippet that will document the request body
*/
public static RequestBodySnippet requestBody(Map<String, Object> attributes) {
return new RequestBodySnippet(attributes);
}
/**
* Returns a {@code Snippet} that will document a subsection of the body of the API
* operation's request payload. The subsection will be extracted using the given
* {@code subsectionExtractor}.
*
* @param subsectionExtractor the subsection extractor
* @return the snippet that will document the request body subsection
*/
public static RequestBodySnippet requestBody(
PayloadSubsectionExtractor<?> subsectionExtractor) {
return new RequestBodySnippet(subsectionExtractor);
}
/**
* Returns a {@code Snippet} that will document a subsection of the body of the API
* operation's request payload. The subsection will be extracted using the given
* {@code subsectionExtractor}. The given attributes will be made available during
* snippet generation.
*
* @param subsectionExtractor the subsection extractor
* @param attributes the attributes
* @return the snippet that will document the request body subsection
*/
public static RequestBodySnippet requestBody(
PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
return new RequestBodySnippet(subsectionExtractor, attributes);
}
/**
* Returns a {@code Snippet} that will document the body of the API operation's
* response payload.
*
* @return the snippet that will document the response body
*/
public static ResponseBodySnippet responseBody() {
return new ResponseBodySnippet();
}
/**
* Returns a {@code Snippet} that will document the body of the API operation's
* response payload. The given attributes will be made available during snippet
* generation.
*
* @param attributes the attributes
* @return the snippet that will document the response body
*/
public static ResponseBodySnippet responseBody(Map<String, Object> attributes) {
return new ResponseBodySnippet(attributes);
}
/**
* Returns a {@code Snippet} that will document a subsection of the body of the API
* operation's response payload. The subsection will be extracted using the given
* {@code subsectionExtractor}.
*
* @param subsectionExtractor the subsection extractor
* @return the snippet that will document the response body subsection
*/
public static ResponseBodySnippet responseBody(
PayloadSubsectionExtractor<?> subsectionExtractor) {
return new ResponseBodySnippet(subsectionExtractor);
}
/**
* Returns a {@code Snippet} that will document a subsection of the body of the API
* operation's response payload. The subsection will be extracted using the given
* {@code subsectionExtractor}. The given attributes will be made available during
* snippet generation.
*
* @param subsectionExtractor the subsection extractor
* @param attributes the attributes
* @return the snippet that will document the response body subsection
*/
public static ResponseBodySnippet responseBody(
PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
return new ResponseBodySnippet(subsectionExtractor, attributes);
}
/**
* Returns a {@code Snippet} that will document the body of specified part of the API
* operation's request payload.
*
* @param partName the name of the request part
* @return the snippet that will document the response body
*/
public static RequestPartBodySnippet requestPartBody(String partName) {
return new RequestPartBodySnippet(partName);
}
/**
* Returns a {@code Snippet} that will document the body of specified part of the API
* operation's request payload. The given attributes will be made available during
* snippet generation.
*
* @param partName the name of the request part
* @param attributes the attributes
* @return the snippet that will document the response body
*/
public static RequestPartBodySnippet requestPartBody(String partName,
Map<String, Object> attributes) {
return new RequestPartBodySnippet(partName, attributes);
}
/**
* Returns a {@code Snippet} that will document a subsection of the body of specified
* part of the API operation's request payload. The subsection will be extracted using
* the given {@code subsectionExtractor}.
*
* @param partName the name of the request part
* @param subsectionExtractor the subsection extractor
* @return the snippet that will document the response body
*/
public static RequestPartBodySnippet requestPartBody(String partName,
PayloadSubsectionExtractor<?> subsectionExtractor) {
return new RequestPartBodySnippet(partName, subsectionExtractor);
}
/**
* Returns a {@code Snippet} that will document a subsection of the body of specified
* part of the API operation's request payload. The subsection will be extracted using
* the given {@code subsectionExtractor}. The given attributes will be made available
* during snippet generation.
*
* @param partName the name of the request part
* @param subsectionExtractor the subsection extractor
* @param attributes the attributes
* @return the snippet that will document the response body
*/
public static RequestPartBodySnippet requestPartBody(String partName,
PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
return new RequestPartBodySnippet(partName, subsectionExtractor, attributes);
}
/**
* Creates a copy of the given {@code descriptors} with the given {@code pathPrefix}
* applied to their paths.

View File

@@ -0,0 +1,84 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import java.util.Map;
import org.springframework.http.MediaType;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.snippet.Snippet;
/**
* A {@link Snippet} that documents the body of a request.
*
* @author Andy Wilkinson
*/
public class RequestBodySnippet extends AbstractBodySnippet {
/**
* Creates a new {@code RequestBodySnippet}.
*/
public RequestBodySnippet() {
this(null, null);
}
/**
* Creates a new {@code RequestBodySnippet} that will document the subsection of the
* request body extracted by the given {@code subsectionExtractor}.
*
* @param subsectionExtractor the subsection extractor
*/
public RequestBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor) {
this(subsectionExtractor, null);
}
/**
* Creates a new {@code RequestBodySnippet} with the given additional
* {@code attributes} that will be included in the model during template rendering.
*
* @param attributes The additional attributes
*/
public RequestBodySnippet(Map<String, Object> attributes) {
this(null, attributes);
}
/**
* Creates a new {@code RequestBodySnippet} that will document the subsection of the
* request body extracted by the given {@code subsectionExtractor}. The given
* additional {@code attributes} that will be included in the model during template
* rendering.
*
* @param subsectionExtractor the subsection extractor
* @param attributes The additional attributes
*/
public RequestBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
super("request", subsectionExtractor, attributes);
}
@Override
protected byte[] getContent(Operation operation) throws IOException {
return operation.getRequest().getContent();
}
@Override
protected MediaType getContentType(Operation operation) {
return operation.getRequest().getHeaders().getContentType();
}
}

View File

@@ -0,0 +1,111 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import java.util.Map;
import org.springframework.http.MediaType;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.operation.OperationRequestPart;
import org.springframework.restdocs.snippet.Snippet;
import org.springframework.restdocs.snippet.SnippetException;
/**
* A {@link Snippet} that documents the body of a request part.
*
* @author Andy Wilkinson
*/
public class RequestPartBodySnippet extends AbstractBodySnippet {
private final String partName;
/**
* Creates a new {@code RequestPartBodySnippet} that will document the body of the
* request part with the given {@code partName}.
*
* @param partName the name of the request part
*/
public RequestPartBodySnippet(String partName) {
this(partName, null, null);
}
/**
* Creates a new {@code RequestPartBodySnippet} that will document the subsection of
* the body of the request part with the given {@code partName} extracted by the given
* {@code subsectionExtractor}.
*
* @param partName the name of the request part
* @param subsectionExtractor the subsection extractor
*/
public RequestPartBodySnippet(String partName,
PayloadSubsectionExtractor<?> subsectionExtractor) {
this(partName, subsectionExtractor, null);
}
/**
* Creates a new {@code RequestPartBodySnippet} that will document the body of the
* request part with the given {@code partName}. The given additional
* {@code attributes} will be included in the model during template rendering.
*
* @param partName the name of the request part
* @param attributes the additional attributes
*/
public RequestPartBodySnippet(String partName, Map<String, Object> attributes) {
this(partName, null, attributes);
}
/**
* Creates a new {@code RequestPartBodySnippet} that will document the body of the
* request part with the given {@code partName}. The subsection of the body extracted
* by the given {@code subsectionExtractor} will be documented and the given
* additional {@code attributes} that will be included in the model during template
* rendering.
*
* @param partName the name of the request part
* @param subsectionExtractor the subsection extractor
* @param attributes The additional attributes
*/
public RequestPartBodySnippet(String partName,
PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
super("request-part-" + partName, "request-part", subsectionExtractor,
attributes);
this.partName = partName;
}
@Override
protected byte[] getContent(Operation operation) throws IOException {
return findPart(operation).getContent();
}
@Override
protected MediaType getContentType(Operation operation) {
return findPart(operation).getHeaders().getContentType();
}
private OperationRequestPart findPart(Operation operation) {
for (OperationRequestPart candidate : operation.getRequest().getParts()) {
if (candidate.getName().equals(this.partName)) {
return candidate;
}
}
throw new SnippetException("A request part named '" + this.partName
+ "' was not found in the request");
}
}

View File

@@ -0,0 +1,84 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import java.util.Map;
import org.springframework.http.MediaType;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.snippet.Snippet;
/**
* A {@link Snippet} that documents the body of a response.
*
* @author Andy Wilkinson
*/
public class ResponseBodySnippet extends AbstractBodySnippet {
/**
* Creates a new {@code ResponseBodySnippet}.
*/
public ResponseBodySnippet() {
this(null, null);
}
/**
* Creates a new {@code ResponseBodySnippet} that will document the subsection of the
* response body extracted by the given {@code subsectionExtractor}.
*
* @param subsectionExtractor the subsection extractor
*/
public ResponseBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor) {
this(subsectionExtractor, null);
}
/**
* Creates a new {@code ResponseBodySnippet} with the given additional
* {@code attributes} that will be included in the model during template rendering.
*
* @param attributes The additional attributes
*/
public ResponseBodySnippet(Map<String, Object> attributes) {
this(null, attributes);
}
/**
* Creates a new {@code ResponseBodySnippet} that will document the subsection of the
* response body extracted by the given {@code subsectionExtractor}. The given
* additional {@code attributes} that will be included in the model during template
* rendering.
*
* @param subsectionExtractor the subsection extractor
* @param attributes The additional attributes
*/
public ResponseBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor,
Map<String, Object> attributes) {
super("response", subsectionExtractor, attributes);
}
@Override
protected byte[] getContent(Operation operation) throws IOException {
return operation.getResponse().getContent();
}
@Override
protected MediaType getContentType(Operation operation) {
return operation.getResponse().getHeaders().getContentType();
}
}

View File

@@ -0,0 +1,4 @@
[source,options="nowrap"]
----
{{body}}
----

View File

@@ -0,0 +1,4 @@
[source,options="nowrap"]
----
{{body}}
----

View File

@@ -0,0 +1,4 @@
[source,options="nowrap"]
----
{{body}}
----

View File

@@ -68,7 +68,11 @@ public abstract class AbstractSnippetTests {
}
public CodeBlockMatcher<?> codeBlock(String language) {
return SnippetMatchers.codeBlock(this.templateFormat, language);
return this.codeBlock(language, null);
}
public CodeBlockMatcher<?> codeBlock(String language, String options) {
return SnippetMatchers.codeBlock(this.templateFormat, language, options);
}
public TableMatcher<?> tableWithHeader(String... headers) {

View File

@@ -31,6 +31,8 @@ import org.springframework.restdocs.cli.HttpieRequestSnippet;
import org.springframework.restdocs.generate.RestDocumentationGenerator;
import org.springframework.restdocs.http.HttpRequestSnippet;
import org.springframework.restdocs.http.HttpResponseSnippet;
import org.springframework.restdocs.payload.RequestBodySnippet;
import org.springframework.restdocs.payload.ResponseBodySnippet;
import org.springframework.restdocs.snippet.Snippet;
import org.springframework.restdocs.snippet.StandardWriterResolver;
import org.springframework.restdocs.snippet.WriterResolver;
@@ -76,7 +78,9 @@ public class RestDocumentationConfigurerTests {
contains(instanceOf(CurlRequestSnippet.class),
instanceOf(HttpieRequestSnippet.class),
instanceOf(HttpRequestSnippet.class),
instanceOf(HttpResponseSnippet.class)));
instanceOf(HttpResponseSnippet.class),
instanceOf(RequestBodySnippet.class),
instanceOf(ResponseBodySnippet.class)));
assertThat(configuration, hasEntry(equalTo(SnippetConfiguration.class.getName()),
instanceOf(SnippetConfiguration.class)));
SnippetConfiguration snippetConfiguration = (SnippetConfiguration) configuration
@@ -138,7 +142,9 @@ public class RestDocumentationConfigurerTests {
contains(instanceOf(CurlRequestSnippet.class),
instanceOf(HttpieRequestSnippet.class),
instanceOf(HttpRequestSnippet.class),
instanceOf(HttpResponseSnippet.class), equalTo(snippet)));
instanceOf(HttpResponseSnippet.class),
instanceOf(RequestBodySnippet.class),
instanceOf(ResponseBodySnippet.class), equalTo(snippet)));
}
@Test

View File

@@ -0,0 +1,95 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import org.junit.Test;
import org.springframework.restdocs.AbstractSnippetTests;
import org.springframework.restdocs.templates.TemplateEngine;
import org.springframework.restdocs.templates.TemplateFormat;
import org.springframework.restdocs.templates.TemplateResourceResolver;
import org.springframework.restdocs.templates.mustache.MustacheTemplateEngine;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.springframework.restdocs.payload.PayloadDocumentation.beneathPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartBody;
import static org.springframework.restdocs.snippet.Attributes.attributes;
import static org.springframework.restdocs.snippet.Attributes.key;
/**
* Tests for {@link RequestPartBodySnippet}.
*
* @author Andy Wilkinson
*/
public class RequestBodyPartSnippetTests extends AbstractSnippetTests {
public RequestBodyPartSnippetTests(String name, TemplateFormat templateFormat) {
super(name, templateFormat);
}
@Test
public void requestPartWithBody() throws IOException {
this.snippets.expect("request-part-one-body")
.withContents(codeBlock(null, "nowrap").content("some content"));
requestPartBody("one").document(this.operationBuilder.request("http://localhost")
.part("one", "some content".getBytes()).build());
}
@Test
public void requestPartWithNoBody() throws IOException {
this.snippets.expect("request-part-one-body")
.withContents(codeBlock(null, "nowrap").content(""));
requestPartBody("one").document(this.operationBuilder.request("http://localhost")
.part("one", new byte[0]).build());
}
@Test
public void subsectionOfRequestPartBody() throws IOException {
this.snippets.expect("request-part-one-body-beneath-a.b")
.withContents(codeBlock(null, "nowrap").content("{\"c\":5}"));
requestPartBody("one", beneathPath("a.b"))
.document(this.operationBuilder.request("http://localhost")
.part("one", "{\"a\":{\"b\":{\"c\":5}}}".getBytes()).build());
}
@Test
public void customSnippetAttributes() throws IOException {
this.snippets.expect("request-part-one-body")
.withContents(codeBlock("json", "nowrap").content("{\"a\":\"alpha\"}"));
TemplateResourceResolver resolver = mock(TemplateResourceResolver.class);
given(resolver.resolveTemplateResource("request-part-body"))
.willReturn(snippetResource("request-part-body-with-language"));
requestPartBody("one",
attributes(
key("language").value("json")))
.document(
this.operationBuilder
.attribute(TemplateEngine.class.getName(),
new MustacheTemplateEngine(
resolver))
.request("http://localhost")
.part("one",
"{\"a\":\"alpha\"}".getBytes())
.build());
}
}

View File

@@ -0,0 +1,92 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import org.junit.Test;
import org.springframework.restdocs.AbstractSnippetTests;
import org.springframework.restdocs.templates.TemplateEngine;
import org.springframework.restdocs.templates.TemplateFormat;
import org.springframework.restdocs.templates.TemplateResourceResolver;
import org.springframework.restdocs.templates.mustache.MustacheTemplateEngine;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.springframework.restdocs.payload.PayloadDocumentation.beneathPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.requestBody;
import static org.springframework.restdocs.snippet.Attributes.attributes;
import static org.springframework.restdocs.snippet.Attributes.key;
/**
* Tests for {@link RequestBodySnippet}.
*
* @author Andy Wilkinson
*/
public class RequestBodySnippetTests extends AbstractSnippetTests {
public RequestBodySnippetTests(String name, TemplateFormat templateFormat) {
super(name, templateFormat);
}
@Test
public void requestWithBody() throws IOException {
this.snippets.expect("request-body")
.withContents(codeBlock(null, "nowrap").content("some content"));
requestBody().document(this.operationBuilder.request("http://localhost")
.content("some content").build());
}
@Test
public void requestWithNoBody() throws IOException {
this.snippets.expect("request-body")
.withContents(codeBlock(null, "nowrap").content(""));
requestBody().document(this.operationBuilder.request("http://localhost").build());
}
@Test
public void subsectionOfRequestBody() throws IOException {
this.snippets.expect("request-body-beneath-a.b")
.withContents(codeBlock(null, "nowrap").content("{\"c\":5}"));
requestBody(beneathPath("a.b"))
.document(this.operationBuilder.request("http://localhost")
.content("{\"a\":{\"b\":{\"c\":5}}}").build());
}
@Test
public void customSnippetAttributes() throws IOException {
this.snippets.expect("request-body")
.withContents(codeBlock("json", "nowrap").content("{\"a\":\"alpha\"}"));
TemplateResourceResolver resolver = mock(TemplateResourceResolver.class);
given(resolver.resolveTemplateResource("request-body"))
.willReturn(snippetResource("request-body-with-language"));
requestBody(
attributes(
key("language").value("json")))
.document(
this.operationBuilder
.attribute(TemplateEngine.class.getName(),
new MustacheTemplateEngine(
resolver))
.request("http://localhost")
.content("{\"a\":\"alpha\"}").build());
}
}

View File

@@ -0,0 +1,92 @@
/*
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.restdocs.payload;
import java.io.IOException;
import org.junit.Test;
import org.springframework.restdocs.AbstractSnippetTests;
import org.springframework.restdocs.templates.TemplateEngine;
import org.springframework.restdocs.templates.TemplateFormat;
import org.springframework.restdocs.templates.TemplateResourceResolver;
import org.springframework.restdocs.templates.mustache.MustacheTemplateEngine;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.springframework.restdocs.payload.PayloadDocumentation.beneathPath;
import static org.springframework.restdocs.payload.PayloadDocumentation.responseBody;
import static org.springframework.restdocs.snippet.Attributes.attributes;
import static org.springframework.restdocs.snippet.Attributes.key;
/**
* Tests for {@link ResponseBodySnippet}.
*
* @author Andy Wilkinson
*/
public class ResponseBodySnippetTests extends AbstractSnippetTests {
public ResponseBodySnippetTests(String name, TemplateFormat templateFormat) {
super(name, templateFormat);
}
@Test
public void responseWithBody() throws IOException {
this.snippets.expect("response-body")
.withContents(codeBlock(null, "nowrap").content("some content"));
PayloadDocumentation.responseBody().document(
this.operationBuilder.response().content("some content").build());
}
@Test
public void responseWithNoBody() throws IOException {
this.snippets.expect("response-body")
.withContents(codeBlock(null, "nowrap").content(""));
PayloadDocumentation.responseBody()
.document(this.operationBuilder.response().build());
}
@Test
public void subsectionOfResponseBody() throws IOException {
this.snippets.expect("response-body-beneath-a.b")
.withContents(codeBlock(null, "nowrap").content("{\"c\":5}"));
responseBody(beneathPath("a.b")).document(this.operationBuilder.response()
.content("{\"a\":{\"b\":{\"c\":5}}}").build());
}
@Test
public void customSnippetAttributes() throws IOException {
this.snippets.expect("response-body")
.withContents(codeBlock("json", "nowrap").content("{\"a\":\"alpha\"}"));
TemplateResourceResolver resolver = mock(TemplateResourceResolver.class);
given(resolver.resolveTemplateResource("response-body"))
.willReturn(snippetResource("response-body-with-language"));
responseBody(
attributes(
key("language").value("json")))
.document(
this.operationBuilder
.attribute(TemplateEngine.class.getName(),
new MustacheTemplateEngine(
resolver))
.response().content("{\"a\":\"alpha\"}")
.build());
}
}

View File

@@ -95,6 +95,15 @@ public final class SnippetMatchers {
return new MarkdownCodeBlockMatcher(language);
}
@SuppressWarnings({ "rawtypes" })
public static CodeBlockMatcher<?> codeBlock(TemplateFormat format, String language,
String options) {
if ("adoc".equals(format.getFileExtension())) {
return new AsciidoctorCodeBlockMatcher(language, options);
}
return new MarkdownCodeBlockMatcher(language);
}
private static abstract class AbstractSnippetContentMatcher
extends BaseMatcher<String> {
@@ -186,7 +195,7 @@ public final class SnippetMatchers {
protected AsciidoctorCodeBlockMatcher(String language, String options) {
super(TemplateFormats.asciidoctor());
this.addLine("[source," + language
this.addLine("[source" + (language == null ? "" : "," + language)
+ (options == null ? "" : ",options=\"" + options + "\"") + "]");
this.addLine("----");
this.addLine("----");
@@ -204,7 +213,7 @@ public final class SnippetMatchers {
protected MarkdownCodeBlockMatcher(String language) {
super(TemplateFormats.markdown());
this.addLine("```" + language);
this.addLine("```" + (language == null ? "" : language));
this.addLine("```");
}

View File

@@ -0,0 +1,4 @@
[source,{{language}},options="nowrap"]
----
{{body}}
----

View File

@@ -0,0 +1,4 @@
[source,{{language}},options="nowrap"]
----
{{body}}
----

View File

@@ -0,0 +1,4 @@
[source,{{language}},options="nowrap"]
----
{{body}}
----

View File

@@ -0,0 +1,3 @@
```{{language}}
{{body}}
```