feat: add new PathPrefix attribute #1685
Open
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
When a group of methods share the same relative URL path prefix, you can use the PathPrefix annotation. When given, the path prefix will be concatenated after the base URL and before the relative path as specified in the method's annotation.
| @@ -68,7 +68,7 @@ internal class RestMethodInfoInternal | |||
| var hma = methodInfo.GetCustomAttributes(true).OfType<HttpMethodAttribute>().First(); | |||
|
|
|||
| HttpMethod = hma.Method; | |||
| RelativePath = hma.Path; | |||
| RelativePath = ReflectionHelpers.GetPathPrefixFor(targetInterface) + hma.Path; | |||
There was a problem hiding this comment.
Is concatenation enough? I think it should also add a / separator if necessary.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1685 +/- ##
==========================================
- Coverage 87.73% 87.72% -0.02%
==========================================
Files 33 34 +1
Lines 2348 2362 +14
Branches 294 297 +3
==========================================
+ Hits 2060 2072 +12
- Misses 208 209 +1
- Partials 80 81 +1 ☔ View full report in Codecov by Sentry. |
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.
What kind of change does this PR introduce?
When a group of methods share the same relative URL path prefix, you can use the PathPrefix annotation. When given, the path prefix will be concatenated after the base URL and before the relative path as specified in the method's annotation.
What is the current behavior?
This is an added feature, so the current behavior is that this is not possible. At the moment, the constructed URL is always a concatenation of the base URL and the method specific relative path.
What is the new behavior?
You now have the possibility to define a PathPrefix on interface level.
What might this PR break?
URL construction in RestMethodInfoInternal.RelativePath, although it should and does not break. When a PathPrefix is omitted, it simply will not be used.
Please check if the PR fulfills these requirements