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

Specify language derived from Content-Type in body snippets

Browse Source 
See gh-797
This commit is contained in:
Achim Grimm
2022-04-24 21:33:00 +02:00
committed by Andy Wilkinson
parent bdba92efe7
commit 9a44205253
7 changed files with 42 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -73,6 +73,11 @@ public abstract class AbstractBodySnippet extends TemplatedSnippet {
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);
@@ -80,6 +85,7 @@ public abstract class AbstractBodySnippet extends TemplatedSnippet {
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;
}

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

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

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

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

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

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

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

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

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

@@ -20,6 +20,8 @@ import java.io.IOException;
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,20 @@ public class RequestBodySnippetTests extends AbstractSnippetTests {
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(

16
spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/ResponseBodySnippetTests.java
View File

@@ -20,6 +20,8 @@ import java.io.IOException;
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,20 @@ public class ResponseBodySnippetTests extends AbstractSnippetTests {
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"))