05 Jun '12, 4pm

A few tips on how to build a well-structured API. » #api #development

A few weeks back, we publicly released the Gauges API . Despite building Gauges from the ground up as an API , it was a lot of work. You really have to cross your t’s and dot your i’s when releasing an API . 1. Document as You Build We made the mistake of documenting after most of the build was done. The problem is documenting sucks. Leaving that pain until the end, when you are excited to release it, makes doing the work twice as hard. Thankfully, we have a closer on our team who powered through it. 2. Be Consistent As we documented the API , we noticed a lot of inconsistencies. For example, in some places we return a hash and in others we returned an array. Upon realizing these issues, we started making some rules. To solve the array/hash issue, we elected that every response should return a hash. This is the most flexible solution going forward. It allows us to inject n...

Full article: http://railstips.org/blog/archives/2011/12/01/creating-an...

Tweets

ASCIIcast 352 - Securing an API

railscasts.com 04 Jun '12, 8pm

, we showed you how to build a versioned API for a store application. We can interact with this application through JSON i...

@brunnogomes the official api doc?

api.rubyonrails.org 08 Jun '12, 12am

Migrations can manage the evolution of a schema used by several physical databases. It’s a solution to the common problem ...

ASCIIcast 350 - REST API Versioning

ASCIIcast 350 - REST API Versioning

railscasts.com 28 May '12, 9pm

We’ll add some routes specifically for the API so that these routes stay separate from the routes for the HTML interface. ...

Episode 352: Securing an API

railscasts.com 24 May '12, 6am

There are many approaches to locking down an API. Here I start off with HTTP Basic authentication then move on to generati...

Great article on @SeoBook on creating linkworthy content

Great article on @SeoBook on creating linkworth...

seobook.com 01 Jun '12, 9pm

Day 7: Creating Linkworthy Content Here are some tips on creating webpages that other website will want to link to—to save...

Rethinking web API development

rubyflow.com 13 Jun '12, 5pm

Rethinking web API development Posted by mattetti on June 13, 2012 — 0 comments Here is an article aboutrethinking web API...

#350 REST API Versioning - RailsCasts

railscasts.com 08 Jun '12, 5am

APIs should be consistent, but it is difficult to do this when returning a JSON response along side the HTML interface. He...

@jcoglan Not Rack extensions, but the API Sinat...

sinatrarb.com 07 Jun '12, 12pm

The “Classic” style, where applications are defined on main / the top-level – most of the examples and documentation targe...

Making Your Online Video Pop - My Top Tips for Web Series

Making Your Online Video Pop - My Top Tips for ...

reelseo.com 04 Jun '12, 6pm

I write a lot about research and trends and some technical aspects of online video. I hardly ever, really, get to talk abo...