OpenFeign / OpenFeign/feign

URL encoding includes parameter names such as "$skip"

Open
#1,705 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feedback provided
Dominant language
Java
Stars
9.8k
Forks
1.9k
Avg merge
1d 2h
Merged PRs (30d)
41

Description

Hi All,

I have the folloging feign client:

@FeignClient(name = "MdsDataClient", url = "${integration.mds.host.url}", decode404 = true)
public interface MdsClient {

    @GetMapping(value = "{path}")
    Response get(
            @PathVariable("path") String path,
            @SpringQueryMap(encoded = true) Map<String, String> params,
            @RequestHeader Map<String, String> headerMap);

}

One of the defined parameters of the provided service is called "$skip".

Instead of GET https://services.com/currency/api/v2?rateType=DQ&from=USD&to=EUR&dateFrom=2012-01-01&dateTo=2012-01-01&$top=1&$skip=0, I end up with the following URI https://services.com/currency/api/v2?rateType=DQ&from=USD&to=EUR&dateFrom=2012-01-01&dateTo=2012-01-01&%24top=1&%24skip=0

I also tried the encoded = true setting on the @SpringQueryMap, but that seems to be take only the values and not the keys into account.

Any insights? A bug? By design? Thanks.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the request from the MdsClient interface with parameter names such as "$skip" and "$top", comparing encoded=true with the observed URI. Trace the query-map encoding behavior and determine whether parameter names should remain unescaped; done means the behavior is clarified through a fix or documented design decision, with a regression check if the project provides one.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.