Skip to content

curl request snippet for a HEAD request hangs waiting for a response body #1087

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

Merged
wilkinsona merged 1 commit into from
Nov 13, 2026
Merged

curl request snippet for a HEAD request hangs waiting for a response body #1087

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
15 changes: 11 additions & 4 deletions spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/CurlRequestSnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import org.jspecify.annotations.Nullable;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.operation.OperationRequest;
Expand Down Expand Up @@ -76,7 +77,7 @@ private String getUrl(Operation operation) {

private String getOptions(Operation operation) {
StringBuilder builder = new StringBuilder();
writeIncludeHeadersInOutputOption(builder);
writeIncludeHeadersInOutputOption(operation.getRequest(), builder);

CliOperationRequest request = new CliOperationRequest(operation.getRequest());
writeUserOptionIfNecessary(request, builder);
Expand Down Expand Up @@ -106,8 +107,8 @@ private void writeCookies(CliOperationRequest request, List<String> lines) {
}
}

private void writeIncludeHeadersInOutputOption(StringBuilder builder) {
builder.append("-i");
private void writeIncludeHeadersInOutputOption(OperationRequest request, StringBuilder builder) {
builder.append(isHeadRequest(request) ? "-I" : "-i");
}

private void writeUserOptionIfNecessary(CliOperationRequest request, StringBuilder builder) {
Expand All @@ -118,7 +119,13 @@ private void writeUserOptionIfNecessary(CliOperationRequest request, StringBuild
}

private void writeHttpMethod(OperationRequest request, StringBuilder builder) {
builder.append(String.format(" -X %s", request.getMethod()));
if (!isHeadRequest(request)) {
builder.append(String.format(" -X %s", request.getMethod()));
}
}

private boolean isHeadRequest(OperationRequest request) {
return HttpMethod.HEAD.equals(request.getMethod());
}

private void writeHeaders(CliOperationRequest request, List<String> lines) {
Expand Down
20 changes: 20 additions & 0 deletions ...restdocs-core/src/test/java/org/springframework/restdocs/cli/CurlRequestSnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,26 @@ void nonGetRequest(OperationBuilder operationBuilder, AssertableSnippets snippet
(codeBlock) -> codeBlock.withLanguage("bash").content("$ curl 'http://localhost/foo' -i -X POST"));
}

@RenderedSnippetTest
void headRequest(OperationBuilder operationBuilder, AssertableSnippets snippets) throws IOException {
new CurlRequestSnippet(this.commandFormatter)
.document(operationBuilder.request("http://localhost/foo").method("HEAD").build());
assertThat(snippets.curlRequest())
.isCodeBlock((codeBlock) -> codeBlock.withLanguage("bash").content("$ curl 'http://localhost/foo' -I"));
}

@RenderedSnippetTest
void headRequestWithHeadersAndBasicAuth(OperationBuilder operationBuilder, AssertableSnippets snippets)
throws IOException {
new CurlRequestSnippet(this.commandFormatter).document(operationBuilder.request("http://localhost/foo")
.method("HEAD")
.header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE)
.header(HttpHeaders.AUTHORIZATION, "Basic " + Base64.getEncoder().encodeToString("user:secret".getBytes()))
.build());
assertThat(snippets.curlRequest()).isCodeBlock((codeBlock) -> codeBlock.withLanguage("bash")
.content("$ curl 'http://localhost/foo' -I -u 'user:secret' -H 'Accept: application/json'"));
}

@RenderedSnippetTest
void requestWithContent(OperationBuilder operationBuilder, AssertableSnippets snippets) throws IOException {
new CurlRequestSnippet(this.commandFormatter)
Expand Down
Loading