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.

Sign up for GitHub

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

Jump to bottom

"Building JSON-LD APIs: Best Practices" #160

Open
8 of 13 tasks
akuckartz opened this issue Aug 7, 2016 · 0 comments
Open
8 of 13 tasks

"Building JSON-LD APIs: Best Practices" #160

akuckartz opened this issue Aug 7, 2016 · 0 comments
Labels
quality specification
Milestone
0.6

Comments

@akuckartz
Copy link

akuckartz commented Aug 7, 2016 •
edited
Loading

Verify that the best practices from http://json-ld.org/spec/latest/json-ld-api-best-practices/ are taken into account:

  • Best Practice 1: Publish data using developer friendly JSON
  • Best Practice 2: Use well-known identifiers when describing data
  • Best Practice 3: Cache JSON-LD Contexts
  • Best Practice 4: Use a top-level object
  • Best Practice 5: Use native values
  • Best Practice 6: Assume arrays are unordered
  • Best Practice 7: Provide one or more types for JSON objects
  • Best Practice 8: Identify objects with a unique identifier
  • Best Practice 9: Provide a representation of the entity related by URL
  • Best Practice 10: External references should use typed term
  • Best Practice 11: Nest referenced inline objects
  • Best Practice 12: Things not strings
  • Best Practice 13: When describing an inverse relationship, use a referenced property
@akuckartz akuckartz added this to the 0.6 milestone Aug 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
quality specification
Projects
None yet
Milestone
0.6
Development

No branches or pull requests
1 participant
@akuckartz