Feign - URL encode path params

Question

This is my contract,

@RequestLine("GET /products/{id}")
@Headers({"Content-Type: application/json"})
ApiResponse getProduct(@Param("id") String productId) throws Exception;

I want to fetch the product with id = "a/b",

If I send this as a param to getProduct("a/b")

then the URL that is formed is http://api/products/a/b and I am getting a 404 instead the url should be http://api/products/a%2Fb

Is there a way around this?

I am using io.github.openfeign feign-core 9.5.0 – NitishDeshpande May 10 '17 at 09:59 — NitishDeshpande, May 10 '17 at 09:59

score 6 · Accepted Answer · edited Sep 06 '18 at 14:11

6

A simple config did it,

@RequestLine(value = "GET /products/{id}", decodeSlash = false)
@Headers({"Content-Type: application/json"})
ApiResponse getProduct(@Param("id") String productId) throws Exception;

The path param was correctly getting encoded but the RequestTemplate was decoding the URL again (decodeSlash=true by default) before sending out the request which was causing the issue.

edited Sep 06 '18 at 14:11

Nikita Bosik

851
1
14
20

answered May 10 '17 at 16:49

NitishDeshpande

435
2
6
19

1

I found the same problem. IMHO it should be a default behaviour :/ If I am passing a path argument, it should be from now on simply encoded till the end... :/ Thanks anyway for showing the solution – Tomasz Jul 23 '18 at 14:11
1

Thanks, this lead me in the right direction. In my case the FeignClient was generated by the openapi-generator so I couldn't change it straight away but I had to adapt the templates. See my answer here: https://stackoverflow.com/a/58712381/1326662 – Ralf Nov 05 '19 at 13:40

score 2 · Answer 2 · answered May 11 '21 at 11:31

In my case, when code looks like this:

@GetMapping(path = "/document/{documentId}/files/{fileId}")
  ResponseEntity<byte[]> getDocument(@PathVariable("documentId") String documentId, @PathVariable(value = "fileId") String fileId);

Also problem was that @PathVariable fileId could be 123/SGINED.

Setting application.property feign.client.decodeSlash=false helped.

Feign - URL encode path params

2 Answers2