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

Merge pull request #797 from achimgrimm

Browse Source 
* gh-797:
  Polish "Specify language derived from Content-Type in body snippets"
  Specify language derived from Content-Type in body snippets

Closes gh-797
This commit is contained in:
Andy Wilkinson
2022-07-15 15:51:05 +01:00
parent bdba92efe7 aa9cef9f02
commit 15980d7486
10 changed files with 114 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2022 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.
@@ -31,6 +31,7 @@ import org.springframework.restdocs.snippet.TemplatedSnippet;
* document a RESTful resource's request or response body.
*
* @author Andy Wilkinson
* @author Achim Grimm
*/
public abstract class AbstractBodySnippet extends TemplatedSnippet {
@@ -73,6 +74,7 @@ public abstract class AbstractBodySnippet extends TemplatedSnippet {
protected Map<String, Object> createModel(Operation operation) {
try {
MediaType contentType = getContentType(operation);
String language = determineLanguage(contentType);
byte[] content = getContent(operation);
if (this.subsectionExtractor != null) {
content = this.subsectionExtractor.extractSubsection(content, contentType);
@@ -80,6 +82,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;
}
@@ -88,6 +91,13 @@ public abstract class AbstractBodySnippet extends TemplatedSnippet {
}
}
private String determineLanguage(MediaType contentType) {
if (contentType == null) {
return null;
}
return (contentType.getSubtypeSuffix() != null) ? contentType.getSubtypeSuffix() : contentType.getSubtype();
}
private Charset extractCharset(MediaType contentType) {
if (contentType == null) {
return null;

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-request-part-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-request-part-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}}
```

36
spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/RequestBodyPartSnippetTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2022 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.
@@ -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;
@@ -61,6 +63,38 @@ public class RequestBodyPartSnippetTests extends AbstractSnippetTests {
.is(codeBlock(null, "nowrap").withContent(""));
}
@Test
public void requestPartWithJsonMediaType() throws IOException {
requestPartBody("one").document(this.operationBuilder.request("http://localhost").part("one", "".getBytes())
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE).build());
assertThat(this.generatedSnippets.snippet("request-part-one-body"))
.is(codeBlock("json", "nowrap").withContent(""));
}
@Test
public void requestPartWithJsonSubtypeMediaType() throws IOException {
requestPartBody("one").document(this.operationBuilder.request("http://localhost").part("one", "".getBytes())
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_PROBLEM_JSON_VALUE).build());
assertThat(this.generatedSnippets.snippet("request-part-one-body"))
.is(codeBlock("json", "nowrap").withContent(""));
}
@Test
public void requestPartWithXmlMediaType() throws IOException {
requestPartBody("one").document(this.operationBuilder.request("http://localhost").part("one", "".getBytes())
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE).build());
assertThat(this.generatedSnippets.snippet("request-part-one-body"))
.is(codeBlock("xml", "nowrap").withContent(""));
}
@Test
public void requestPartWithXmlSubtypeMediaType() throws IOException {
requestPartBody("one").document(this.operationBuilder.request("http://localhost").part("one", "".getBytes())
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_ATOM_XML_VALUE).build());
assertThat(this.generatedSnippets.snippet("request-part-one-body"))
.is(codeBlock("xml", "nowrap").withContent(""));
}
@Test
public void subsectionOfRequestPartBody() throws IOException {
requestPartBody("one", beneathPath("a.b")).document(this.operationBuilder.request("http://localhost")

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

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2022 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.
@@ -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,34 @@ public class RequestBodySnippetTests extends AbstractSnippetTests {
assertThat(this.generatedSnippets.snippet("request-body")).is(codeBlock(null, "nowrap").withContent(""));
}
@Test
public void requestWithJsonMediaType() 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 requestWithJsonSubtypeMediaType() throws IOException {
requestBody().document(this.operationBuilder.request("http://localhost")
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_PROBLEM_JSON_VALUE).build());
assertThat(this.generatedSnippets.snippet("request-body")).is(codeBlock("json", "nowrap").withContent(""));
}
@Test
public void requestWithXmlMediaType() throws IOException {
requestBody().document(this.operationBuilder.request("http://localhost")
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE).build());
assertThat(this.generatedSnippets.snippet("request-body")).is(codeBlock("xml", "nowrap").withContent(""));
}
@Test
public void requestWithXmlSubtypeMediaType() 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(

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

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2022 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.
@@ -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,34 @@ public class ResponseBodySnippetTests extends AbstractSnippetTests {
assertThat(this.generatedSnippets.snippet("response-body")).is(codeBlock(null, "nowrap").withContent(""));
}
@Test
public void responseWithJsonMediaType() 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 responseWithJsonSubtypeMediaType() throws IOException {
new ResponseBodySnippet().document(this.operationBuilder.response()
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_PROBLEM_JSON_VALUE).build());
assertThat(this.generatedSnippets.snippet("response-body")).is(codeBlock("json", "nowrap").withContent(""));
}
@Test
public void responseWithXmlMediaType() throws IOException {
new ResponseBodySnippet().document(this.operationBuilder.response()
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE).build());
assertThat(this.generatedSnippets.snippet("response-body")).is(codeBlock("xml", "nowrap").withContent(""));
}
@Test
public void responseWithXmlSubtypeMediaType() 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"))