Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Does this conform to jsonapi.org rendering format? #16

Closed
simkimsia opened this issue Apr 26, 2018 · 2 comments
Closed

Does this conform to jsonapi.org rendering format? #16

simkimsia opened this issue Apr 26, 2018 · 2 comments

Comments

@simkimsia
Copy link

I cannot tell but does this conform to jsonapi.org specification on how to render the JSON format?

@rsinger86
Copy link
Owner

Nah, this takes the approach of transforming simpler fields - often hyperlink strings or PK ints - into complex, nested objects. Looks like JSON API instead appends the related objects in an included field.

There is this project, which offers some level of support for JSON API -- not sure about its support for dynamic embedding.

My (small) team prefers the direct expansion approach; see Stripe for an example of a major API that does same. Though, if you're working on a larger team, I can definitely see benefit of looking to a well-documented standard like JSON API, rather than trying to come up with and standardize on your own spec.

@simkimsia
Copy link
Author

simkimsia commented May 2, 2018

Thanks for the clarification @rsinger86 I still need to think more about it. If you and Stripe prefer the direct expansion approach, there's must be a good reason for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants