-
Notifications
You must be signed in to change notification settings - Fork 10.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix OpenAPI server URLs for Aspire scenarios #60673
base: release/9.0
Are you sure you want to change the base?
Conversation
* Support resolving OpenAPI server URLs from HttpRequest * Try passing optional params everywhere
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Overview
This PR fixes the generation of OpenAPI server URLs in proxy scenarios by properly using X-Forwarded-Proto and X-Forwarded-Host headers to compute the externally accessible URLs.
- Adds new tests to validate behavior with different forwarded header values.
- Updates the OpenApiDocumentService API to accept an optional HttpRequest parameter and adjust server URL construction accordingly.
- Modifies the endpoint extension to propagate the HttpRequest to the document service.
Reviewed Changes
File | Description |
---|---|
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiDocumentService/OpenApiDocumentServiceTests.Servers.cs | Introduces tests validating the use of forwarded headers and expected URL generation. |
src/OpenApi/src/Services/OpenApiDocumentService.cs | Updates method signatures and logic to use the optional HttpRequest for URL generation. |
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiDocumentServiceTestsBase.cs | Updates verification calls to pass null for the httpRequest parameter where not applicable. |
src/OpenApi/src/Extensions/OpenApiEndpointRouteBuilderExtensions.cs | Adjusts method calls to pass the HttpRequest in order to leverage the new URL generation logic. |
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
...NetCore.OpenApi.Tests/Services/OpenApiDocumentService/OpenApiDocumentServiceTests.Servers.cs
Show resolved
Hide resolved
Hi @captainsafia. Please make sure you've updated the PR description to use the Shiproom Template. Also, make sure this PR is not marked as a draft and is ready-to-merge. To learn more about how to prepare a servicing PR click here. |
This reverts commit bf991f6.
Description
This PR supports respecting he X-Forwarded-Proto and X-Forwarded-Host headers when generating server URLs in OpenAPI documents. When these headers are present in the request, the OpenAPI document service will use them to generate the correct server URLs instead of using the original host and scheme values derived from the service configuration.
This is particularly useful in environments where the API is behind a proxy, load balancer, or gateway, allowing the generated OpenAPI document to correctly reference the public-facing URL rather than the internal service URL.
Fixes #57332
Customer Impact
Without this change, documents served behind reverse proxies or forwarded endpoints do not reflect the correct service URl, particularly impact for the ASP.NET Core + Aspire scenario. While the issue is easy to workaround, we want a smoother experience with Aspire out-of-the-box.
Regression?
Risk
Low-risk, becase change as it only affects the generation of server URLs in OpenAPI documents and does not impact the actual API functionality.
Verification
Packaging changes reviewed?