Add path parameter ID suffix convention - #36
Open
tomasvanrijsse wants to merge 3 commits into
Open
Conversation
Add configurable path parameter naming convention that appends "Id"
suffix for clearer parameter names. This follows common PHP/REST API
conventions where path parameters represent identifiers.
Example: /users/{user} → $userId parameter
Changes:
- Added appendIdToPathParameters config option (default: false)
- Added transformPathParameter() in RequestGenerator and ResourceGenerator
- Transform parameter names in constructor signatures
- Transform parameter references in resolveEndpoint() method
- Transform parameter names in resource method signatures
- Maintain backward compatibility (disabled by default)
Configuration:
new Config(
connectorName: 'MyApi',
namespace: 'MyNamespace',
appendIdToPathParameters: true // Enable ID suffix
)
Test coverage:
- Added test to verify feature works when enabled
- All existing tests pass (backward compatible)
Related to Phase 1, PR crescat-io#7 of generator improvements.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add path parameter naming convention that appends "Id" suffix for clearer parameter names.
This follows common PHP/REST API conventions where path parameters represent identifiers.
Example: /users/{user} → $userId parameter
This might be a personal preference, but having properties like
$userwhere the value should be$user->idis confusing to me. This obviously only applies to APIs that have path parameters that lack the Id suffix (which is the default for Laravel routes). Let me know what you think.Changes: