codeforamerica / cfapi

The Code for America API. Tracks and motivates activity and participation across the civic technology movement.
http://codeforamerica.org/api
MIT License
113 stars 52 forks source link

Hypermedia standards #256

Open beechnut opened 8 years ago

beechnut commented 8 years ago

With relationship links mixed with attributes mixed in with side-loaded records, the present structure of the API is harder to read and parse than it needs to be.

I'd like to see this project eventually adopt a Hypermedia standard. My intent is to spark a dialogue and hopefully a transition to adopting a Hypermedia standard, be it JSONAPI (implementations), HAL, Collection-JSON, Siren, or something else that serves our need.

118 was opened over a year ago, and it's still open, so this is partly a way of reviving that, and partly broadening the possibilities to beyond JSON LD + Hydra.