[AMORO-3038] Unify the API set for dashboard and open API #3244
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
module:ams-server
mansonliwh
force-pushed
the
feature-unifyapi
branch
2 times, most recently
from
9f2aaed
to
90dbee5
Compare
czy006
reviewed
Oct 13, 2024
After merging, I will continue to improve this part of the functionality in a new PR. |
zhoujinsong
reviewed
Oct 14, 2024
| @@ -355,7 +354,8 @@ private EndpointGroup apiGroup() { | |||
|
|
|||
| public void preHandleRequest(Context ctx) { | |||
| String uriPath = ctx.path(); | |||
| if (needApiKeyCheck(uriPath)) { | |||
| String requestSource = ctx.header("X-Request-Source"); | |||
| if (needApiKeyCheck(uriPath) && !"frontend".equals(requestSource)) { | |||
There was a problem hiding this comment.
Is Web a proper name for requests from the front end?
And we may better declare a static final variable for it, and the same to X-Request-Source
There was a problem hiding this comment.
Thank you for your reasonable suggestions. I will optimize the code accordingly.
mansonliwh
force-pushed
the
feature-unifyapi
branch
from
90dbee5
to
18b1204
Compare
zhoujinsong
approved these changes
Oct 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are the changes needed?
Close #3038.
Brief change log
Unify the API set for both dashboard and Open API in the same url [ /api/ams/v1 ].
Previously, frontend requests and external interface requests were distinguished by using the paths ams/v1 and api/ams/v1 respectively. Frontend requests required cookie validation for login status, while external interface requests needed to pass an apikey parameter for verification. In this design, the request paths from both sources are unified to api/ams/v1. For frontend requests, an additional header parameter X-Request-Source: frontend will be included. This allows the source of the request to be distinguished and routed to different validation logic accordingly.
How was this patch tested?
[ ☑️ ] Add screenshots for manual tests if appropriate
[ ☑️ ] Run test locally before making a pull request