achmiral/api-best-practices.markdown

Forked from rrgayhart/api-best-practices.markdown

Created November 17, 2018 17:21

Star () You must be signed in to star a gist
Fork () You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/achmiral/ed2f2242998ad8e1b25035ea287ffdd8.js"></script>
Save achmiral/ed2f2242998ad8e1b25035ea287ffdd8 to your computer and use it in GitHub Desktop.

Download ZIP

API Best Practices

Raw

api-best-practices.markdown

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

Spec

Typically implemented through libraries

List of Implementations

Some Implementations of Note*

The Original - Ember Data
Redux JSON API
Active Model Serializers [Note: said to be a little out of date with the standard]
JSONapiForRails

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