API Best Practices: Spec Driven Development (Part 2)

November 20 2014

0 comments

This is part two of the API design best practices series.

Define Your API in a Flexible, but Standard Spec

I cannot stress the importance of spec driven development enough.  One of the quickest ways to kill your API is to define the API in your code, instead of coding to its definition.

How RAML Saved My Email

motif

In today’s post, I’d like to tell you a short story about a bizarre love triangle between a server-side application (Gmail), a client (Mailbox), and the “hero of the day” (API Notebook).

Before starting, let me mention that API Notebook is a web-based, persistent, JavaScript scripting workspace that enables live testing and exploring of APIs. It’s an example of literate programming.