- Notifications
You must be signed in to change notification settings - Fork11.7k
[12.x] JSON:API Resource#57571
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
crynobone wants to merge77 commits into12.xChoose a base branch
base:12.x
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Draft
[12.x] JSON:API Resource#57571
Uh oh!
There was an error while loading.Please reload this page.
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
src/Illuminate/Http/Resources/JsonApi/Exceptions/ResourceIdentificationException.phpShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
* [JSON:API] Add `toAttributes()` methodSigned-off-by: Mior Muhammad Zaki <crynobone@gmail.com>* wipSigned-off-by: Mior Muhammad Zaki <crynobone@gmail.com>* wipSigned-off-by: Mior Muhammad Zaki <crynobone@gmail.com>* Apply fixes from StyleCI* wipSigned-off-by: Mior Muhammad Zaki <crynobone@gmail.com>* formatting---------Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>Co-authored-by: StyleCI Bot <bot@styleci.io>Co-authored-by: Taylor Otwell <taylor@laravel.com>
* [JSON:API] Allows `JsonApiResource::$attributes`Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>* Apply fixes from StyleCI* Update testsSigned-off-by: Mior Muhammad Zaki <crynobone@gmail.com>* formatting---------Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>Co-authored-by: StyleCI Bot <bot@styleci.io>Co-authored-by: Taylor Otwell <taylor@laravel.com>
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
This PR allows you to output your API Resources using
JSON:APIspecification instead of normal JSON viaJsonResource. Without refactoring existing code you can do this using:use App\Models\User;use Illuminate\Support\Facades\Route;Route::get('/users/{user}', function (User $user) {- return $user->toResource();+ return $user->toResource()->asJsonApi();});You can also update your existing resource class to extends
JsonApiResourceinstead ofJsonResource:Relationships
The response from
JsonApiResourcewill not lazy load relationships, you need to manually eager-loads it using the following code:You can utilise query string format such as
/users/11?include=posts,teamsusing the following code:Server Implementation
You can configure
jsonapiobjecthttps://jsonapi.org/format/#document-jsonapi-object on each response usingJsonApiResource::configure()method.