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

Polish "Specify language derived from Content-Type in body snippets"

Browse Source 
See gh-797
This commit is contained in:
Andy Wilkinson
2022-07-15 15:47:31 +01:00
parent 9a44205253
commit aa9cef9f02
6 changed files with 81 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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")

20
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.
@@ -61,14 +61,28 @@ public class RequestBodySnippetTests extends AbstractSnippetTests {
}
@Test
public void requestWithMediaTypeJson() throws IOException {
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 requestWithMediaTypeXml() throws IOException {
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(""));

20
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.
@@ -61,14 +61,28 @@ public class ResponseBodySnippetTests extends AbstractSnippetTests {
}
@Test
public void responseWithMediaTypeJson() throws IOException {
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 responseWithMediaTypeXml() throws IOException {
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(""));