Skip to content

Specify the language in body snippets based on the request or response's content type #797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
achimgrimm wants to merge 1 commit into from
Closed

Specify the language in body snippets based on the request or response's content type #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...restdocs-core/src/main/java/org/springframework/restdocs/payload/AbstractBodySnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,19 @@ 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;
}
Expand Down
2 changes: 1 addition & 1 deletion ...resources/org/springframework/restdocs/templates/asciidoctor/default-request-body.snippet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[source,options="nowrap"]
[source{{#language}},{{language}}{{/language}},options="nowrap"]
----
{{body}}
----
2 changes: 1 addition & 1 deletion ...esources/org/springframework/restdocs/templates/asciidoctor/default-response-body.snippet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[source,options="nowrap"]
[source{{#language}},{{language}}{{/language}},options="nowrap"]
----
{{body}}
----
2 changes: 1 addition & 1 deletion ...in/resources/org/springframework/restdocs/templates/markdown/default-request-body.snippet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
```
```{{#language}}{{language}}{{/language}}
{{body}}
```
2 changes: 1 addition & 1 deletion ...n/resources/org/springframework/restdocs/templates/markdown/default-response-body.snippet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
```
```{{#language}}{{language}}{{/language}}
{{body}}
```
16 changes: 16 additions & 0 deletions ...docs-core/src/test/java/org/springframework/restdocs/payload/RequestBodySnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -58,6 +60,20 @@ 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(
Expand Down
16 changes: 16 additions & 0 deletions ...ocs-core/src/test/java/org/springframework/restdocs/payload/ResponseBodySnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -58,6 +60,20 @@ 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"))
Expand Down