OpenAPITools / OpenAPITools/openapi-generator
[csharp-netcore] Generic Host: Server port is ignored in API requests
Nobody has claimed this yet.
- 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?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
openapi-generator version
6.0.1
OpenAPI declaration file content or url
any file that specifies a server with a non-standard port (ie. not port 80 for http, or port 443 for https)
Generation Details
In the ASP.Net WebApi Project, use swagger with following server addition:
app.UseSwagger(options =>
options.PreSerializeFilters.Add((swagger, httpReq) =>
swagger.Servers = new List<OpenApiServer>
{
new OpenApiServer
{
Url = "https://localhost.7080",
Description = "My Awesome API"
}
}
));
Generate client code:
java -jar openapi-generator-cli-6.0.1.jar generate \
-i myApiDefinition.json \
-g csharp-netcore \
-c config.json \
-o ./client-stub
and here the config.json:
{
"packageName": "TemplateApi",
"optionalAssemblyInfo": true,
"optionalProjectFile": true,
"targetFramework": "net6.0",
"modelPropertyNaming": "original",
"netCoreProjectFile": true,
"library": "generichost"
}
Steps to reproduce
- Run a REST server on a non-standard Port
- generate openApi.json containing the server path
- try using the client
Expected Results
I'd expect the client to correctly use the host AND port of the given server
Actual Results
The client fails to connect to the server, as it tries connecting to the standard port of the given scheme
Related issues/PRs
#12795
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce with the provided openapi.json server definition using https://localhost:7080, the csharp-netcore generator, and config.json. Inspect the generated client’s request setup and confirm that requests use the declared host and non-standard port instead of the scheme’s default port.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100