Modify response- and request-body snippets to have language attribute depending on Content-Type header

Author: achimgrimm

spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/AbstractBodySnippet.java

@@ -73,13 +73,18 @@ protected AbstractBodySnippet(String name, String type, PayloadSubsectionExtract
 	protected Map<String, Object> createModel(Operation operation) {
 		try {
 			MediaType contentType = getContentType(operation);
+			String language = null;
+			if(contentType != null) {
+				language = contentType.getSubtypeSuffix() != null ? contentType.getSubtypeSuffix() : contentType.getSubtype();
+			}
 			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("language", language);
 			model.put("body", body);
 			return model;
 		}

spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates/asciidoctor/default-request-body.snippet

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

spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates/asciidoctor/default-response-body.snippet

@@ -1,3 +1,3 @@
-```
+```{{#language}}{{language}}{{/language}}
 {{body}}
 ```

spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates/markdown/default-request-body.snippet

@@ -1,3 +1,3 @@
-```
+```{{#language}}{{language}}{{/language}}
 {{body}}
 ```

spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates/markdown/default-response-body.snippet

@@ -20,6 +20,8 @@
 
 import org.junit.Test;
 
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
 import org.springframework.restdocs.AbstractSnippetTests;
 import org.springframework.restdocs.templates.TemplateEngine;
 import org.springframework.restdocs.templates.TemplateFormat;
@@ -58,6 +60,24 @@ public void requestWithNoBody() throws IOException {
 		assertThat(this.generatedSnippets.snippet("request-body")).is(codeBlock(null, "nowrap").withContent(""));
 	}
 
+	@Test
+	public void requestWithMediaTypeJson() throws IOException {
+		requestBody().document(this.operationBuilder.request("http://localhost")
+													.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
+													.build());
+		assertThat(this.generatedSnippets.snippet("request-body"))
+						.is(codeBlock("json", "nowrap").withContent(""));
+	}
+
+	@Test
+	public void requestWithMediaTypeXml() throws IOException {
+		requestBody().document(this.operationBuilder.request("http://localhost")
+													.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_ATOM_XML_VALUE)
+													.build());
+		assertThat(this.generatedSnippets.snippet("request-body"))
+						.is(codeBlock("xml", "nowrap").withContent(""));
+	}
+
 	@Test
 	public void subsectionOfRequestBody() throws IOException {
 		requestBody(beneathPath("a.b")).document(

spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/RequestBodySnippetTests.java

@@ -20,6 +20,8 @@
 
 import org.junit.Test;
 
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
 import org.springframework.restdocs.AbstractSnippetTests;
 import org.springframework.restdocs.templates.TemplateEngine;
 import org.springframework.restdocs.templates.TemplateFormat;
@@ -29,8 +31,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 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.payload.PayloadDocumentation.*;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestBody;
 import static org.springframework.restdocs.snippet.Attributes.attributes;
 import static org.springframework.restdocs.snippet.Attributes.key;
 
@@ -58,6 +60,22 @@ public void responseWithNoBody() throws IOException {
 		assertThat(this.generatedSnippets.snippet("response-body")).is(codeBlock(null, "nowrap").withContent(""));
 	}
 
+	@Test
+	public void responseWithMediaTypeJson() throws IOException {
+		new ResponseBodySnippet().document(this.operationBuilder.response()
+																.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
+																.build());
+		assertThat(this.generatedSnippets.snippet("response-body")).is(codeBlock("json", "nowrap").withContent(""));
+	}
+
+	@Test
+	public void responseWithMediaTypeXml() throws IOException {
+		new ResponseBodySnippet().document(this.operationBuilder.response()
+																.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_ATOM_XML_VALUE)
+																.build());
+		assertThat(this.generatedSnippets.snippet("response-body")).is(codeBlock("xml", "nowrap").withContent(""));
+	}
+
 	@Test
 	public void subsectionOfResponseBody() throws IOException {
 		responseBody(beneathPath("a.b"))