feat(controllers): using the PlaceholderAction #1655
Merged
Conversation
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
The documentation leads to create a custom controller/action in order to create a custom operation. However, API Platform provides an undocumented alternative: using the ApiPlatform\Action\PlaceholderAction which prevents to create a custom controller in order to create a custom operation. Indeed, in complex cases, it prevents ending with a codebase overwhelmed by custom controllers which only exist because of the existence of the mandatory "controller" attribute. In the long term, it could be a good idea for the Developer Experience to make this attribute optional so that API Platform uses the ApiPlatform\Action\PlaceholderAction by default.
dunglas
approved these changes
Nov 16, 2022
alanpoulain
reviewed
Nov 17, 2022
|
Would you like to make the PR in the core @nxtpge? |
|
Thanks! |
@alanpoulain Yes, thank you. I will try by myself this weekend and keep you informed if I succeed or have questions (on GitHub Discussions?). |
|
Alright then! You can open the PR and ask questions on it if needed. |
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.
The documentation leads to create a custom controller/action in order to create a custom operation.
However, API Platform provides an undocumented alternative: using the
ApiPlatform\Action\PlaceholderActionwhich prevents to create a custom controller in order to create a custom operation.Indeed, in complex cases, it prevents ending with a codebase overwhelmed by custom controllers which only exist because of the existence of the mandatory
controllerattribute.In the long term, it could be a good idea for the Developer Experience to make this attribute optional so that API Platform uses the
ApiPlatform\Action\PlaceholderActionby default.