Skip to content

Instantly share code, notes, and snippets.

@renoirb

renoirb/READ.md

Last active January 13, 2016 16:16
Show Gist options
  • Save renoirb/d38466ceddae2f1eb7e6 to your computer and use it in GitHub Desktop.
Save renoirb/d38466ceddae2f1eb7e6 to your computer and use it in GitHub Desktop.
Download ZIP
BrowserCompat Reading list
Raw
READ.md

BrowserCompat

Reading list recursion path

During Renoir's contract

What Renoir wrote

By John/Stephanie

Whys

Some notes about tech. questions I had, and why current design is awesome.

See more answers and thoughts in https://browsercompat.readthedocs.org/en/latest/draft/issues.html

Why do we use versioned API

Because if we change structure we want to keep things in place for relying parties.

Great rationale explanation given http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html

Why are we using JSONAPI instead of foo?

Because it's great design. It's not Hypermedia (HAL) but doesn't matter much, because the payback is a self-documenting output that you can walk through. Because it's designed for that in mind.

It's been drafted by Steve Klabnik who had great writing on API design. See talks below.

A crawler can then walk and get what it needs, here's a prototype https://gist.github.com/renoirb/e3f521b730dd07411b59 written in less than an hour illustrating how awesome it is!

Another example of how crawling the API works is documented https://docs.google.com/document/d/1dsqd8cR6muRppQIIbcFs3PrTYZYSPAYz7UuwzsSykqo

How JSONAPI handles changesets

See http://browsercompat.readthedocs.org/en/latest/draft/change-control.html

Key mailing-list threads

Related

See also

Elsewhere

Source; David Storey @Microsoft

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