Skip to content

Instantly share code, notes, and snippets.

@achmiral
Forked from rrgayhart/api-best-practices.markdown
Created November 17, 2018 17:21
Show Gist options
  • Save achmiral/ed2f2242998ad8e1b25035ea287ffdd8 to your computer and use it in GitHub Desktop.
Save achmiral/ed2f2242998ad8e1b25035ea287ffdd8 to your computer and use it in GitHub Desktop.
API Best Practices

The JSON API Standard

What is the JSON API Standard

The Specification

  • The History
  • Why does it exist?
    • Bike Shedding/LookingFor
  • Do we have to use it?
  • What are the important takeaways?

Document Structure

Typically implemented through libraries

Some Implementations of Note*

Returning Data

Pagination

Your Turn

  • Spend the next ten minutes reading the pagination spec to see if our application meets the JSON api standard.

Error Objects

Your Turn

  • Look through your Ideabox projects
    • What would you have needed to add to your API to render error messages in your view?

Digging Deeper

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment