Spring REST Docs duplicates query parameter without value in curl and HTTP request snippets

Question

I'm using Spring REST Docs (2.0.3.RELEASE) and Spring Auto Restdocs (2.0.6) to document a REST API.

When the request contains a query parameter that has no assigned value (empty string) the snippets produced by CliDocumentation.curlRequest() and HttpDocumentation.httpRequest() show the parameter duplicated. For example:

$ curl 'http://localhost:7001/my.app/books?code=&code=' -i -X

This happens whether I do

this.mockMvc.perform(
    get("/my.app/books?code=")
    ...

or

this.mockMvc.perform(
    get("/my.app/books").param("code", "")
    ...

This is similar to issue and duplicate, however this only happens for valueless parameters and the bug mentioned there was fixed in version 1.1.2.RELEASE of Spring REST Docs.

Note: I assume the issue is not with Spring Auto Restdocs since these are standard Spring REST Docs snippets.

Am I missing something?

This is a bug in Spring REST Docs. Could you please open an issue so that we can fix it? — Andy Wilkinson
– Andy Wilkinson, Commented Oct 3, 2019 at 17:18

Bruno Silva · Accepted Answer · 2019-10-07 10:13:08Z

1

As mentioned in the comments, this was a minor bug in Spring REST Docs that has been promptly fixed by @AndyWilkinson in this commit, to be released in version 2.0.5.RELEASE. Many thanks to @AndyWilkinson!

answered Oct 7, 2019 at 10:13

Bruno Silva

113 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Spring REST Docs duplicates query parameter without value in curl and HTTP request snippets

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related