[12.x] Document JSON:API Resource #10988
Draft
+45
−0
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
What is this PR doing? This PR adds documentation for the new JsonApiResource feature introduced in Laravel 12.45.0. It includes: Instructions on how to generate a JSON:API resource using the --json-api flag. An explanation of how the JsonApiResource automatically structures the JSON output to adhere to the JSON:API specification (wrapping attributes, handling id and type). A code example showing a basic implementation and the resulting JSON structure. Why is this change being made? With the release of Laravel 12.45.0, developers now have native support for creating JSON:API compliant resources. However, this feature is not yet mentioned in the official Eloquent: API Resources documentation. Adding this section ensures that the documentation stays up-to-date with the latest framework features and helps developers implement the specification correctly. Reference This documentation corresponds to the framework changes in: Framework PR: laravel/framework#57571 Release: Laravel v12.45.0
Member
|
Mainly considering this a beta feature for now that will be stable on Laravel 13. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 is this PR doing?
This PR adds documentation for the new
JsonApiResourcefeature introduced in Laravel 12.45.0. It includes:Instructions on how to generate a JSON:API resource using the
--json-apiflag.An explanation of how the
JsonApiResourceautomatically structures the JSON output to adhere to the JSON:API specification (wrapping attributes, handlingidandtype).A code example showing a basic implementation and the resulting JSON structure.
Why is this change being made?
With the release of Laravel 12.45.0, developers now have native support for creating JSON:API compliant resources. However, this feature is not yet mentioned in the official Eloquent: API Resources documentation. Adding this section ensures that the documentation stays up-to-date with the latest framework features and helps developers implement the specification correctly.
Reference
This documentation corresponds to the framework changes in:
Framework PR: laravel/framework#57571
Release: Laravel v12.45.0