Skip to content

HTTP request snippet for PATCH, POST and PUT requests with no body has an incorrectly inferred Content-Type header #1018

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −1
Open

HTTP request snippet for PATCH, POST and PUT requests with no body has an incorrectly inferred Content-Type header #1018

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
2 changes: 1 addition & 1 deletion spring-restdocs-core/src/main/java/org/springframework/restdocs/http/HttpRequestSnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ private void writeMultipartEnd(PrintWriter writer) {

private boolean requiresFormEncodingContentTypeHeader(OperationRequest request) {
return request.getHeaders().get(HttpHeaders.CONTENT_TYPE) == null && isPutPostOrPatch(request)
&& !includeParametersInUri(request);
&& request.getContent().length > 0 && !includeParametersInUri(request);
}

private Map<String, String> header(String name, String value) {
Expand Down
16 changes: 16 additions & 0 deletions ...estdocs-core/src/test/java/org/springframework/restdocs/http/HttpRequestSnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,22 @@ void deleteWithQueryString(OperationBuilder operationBuilder, AssertableSnippets
.isHttpRequest((request) -> request.delete("/foo?a=alpha&b=bravo").header("Host", "localhost"));
}

@RenderedSnippetTest
void postFormUrlEncodedRequestIsDocumentedWhenContentTypeIsExplicit(OperationBuilder operationBuilder,
AssertableSnippets snippets) throws IOException {
String body = "a=alpha&b=bravo";
new HttpRequestSnippet().document(operationBuilder.request("http://localhost/foo")
.method("POST")
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_FORM_URLENCODED_VALUE)
.content(body)
.build());
assertThat(snippets.httpRequest()).isHttpRequest((request) -> request.post("/foo")
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_FORM_URLENCODED_VALUE)
.header(HttpHeaders.HOST, "localhost")
.header(HttpHeaders.CONTENT_LENGTH, body.getBytes().length)
.content(body));
}

private String createPart(String content) {
return this.createPart(content, true);
}
Expand Down
Loading