[Feature] Support encoded resource ids #55
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
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.
This feature adds support for resource ids being encodeable. This allows the developer to encode model ids when serializing to JSON:API resources, and for them to be decoded when parsing resource IDs sent by the client.
To add ID encoding, the
IDfield must implemented theLaravelJsonApi\Contracts\Schema\IdEncoderinterface.An example use case is needed to hash ids as per #41. As using hashids is a commen use case, we have added the
laravel-json-api/hashidspackage, that adds hashid support via aHashIdfield class. The dummy application in thetestsfolder has been updated so that ids are hashed for all test models with integer ids.Closes #41