Best Practices for Designing a Pragmatic RESTful API | RESTful API design guidelines
YourdatamodelhasstartedtostabilizeandyoureinapositiontocreateapublicAPIforyourwebapp.YourealizeitshardtomakesignificantchangestoyourAPIonceitsreleasedandwanttogetasmuchrightaspossibleupfront.Now,theinternethasnoshortageonopinionsonAPIdesign.But,sincetheresnoonewidelyadoptedstandardthatworksinallcases,youreleftwithabunchofchoices:Whatformatsshouldyouaccept?Howshouldyouauthenticate?ShouldyourAPIbeversioned?IndesigninganAPIforEnchant[1](aZendeskAlternative[2]),Ivetriedtocomeupwithpragmaticanswe...
Your data model has started to stabilize and youre in a position to create a public API for your web app. You realize its hard to make significant changes to your API once its released and want to get as much right as possible up front. Now, the internet has no shortage on opinions on API design. But, since theres no one widely adopted standard that works in all cases, youre left with a bunch of choices: What formats should you accept? How should you authenticate? Should your API be versioned?
In designing an API for Enchant[1] (a Zendesk Alternative[2]), Ive tried to come up with pragmatic answers to these questions. My goal is for the Enchant API[3] to be easy to use, easy to adopt and flexible enough to dogfood[4] for our own user interfaces.
Really enjoyed this article on REST API design. Heavily informing the part of Starfighters game that exposes an API. http://t.co/2cOwC5Ey9E[5]