OpenAPITools / OpenAPITools/openapi-generator

[BUG][Java][RestClient] Base url of RestClient is ignored

Open
#18,797 5 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description

The baseUrl of the spring restclient is ignored, but instead, the basePath of the ApiClient is used. This is incorrect behaviour.

openapi-generator version

Since inception of library: 7.6.0.

OpenAPI declaration file content or url

Any declaration.

Generation Details

Java with the restclient library.

Steps to reproduce

Generate a client using Java with spring restclient as a library. Create an instance of an API, e.g.
MyApi(ApiClient(someRestClientBuilder.baseUrl(url).build())) then call an API. This will fall-back to the default url configured in the ApiClient localhost, but this should be url.

A workaround is to write something like MyApi(ApiClient(someRestClientBuilder.baseUrl(url).build()).setBasePath(url))

Related issues/PRs

None found

Suggest a fix

I will make a PR, if I have the time.

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 with the generated Java spring restclient entry points described in the issue: MyApi, ApiClient, and the RestClient builder. Reproduce the call using baseUrl(url), then compare how that value and ApiClient's default basePath are used. Done means requests use the builder's URL without requiring setBasePath(url); the payload names no test file, so add or locate coverage for this reproduction.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.