The Rodeo del Jefe

Writings and collections of Robert Jefe Lindstaedt

Collection of Production API Guidelines for Building Great Teams

Building engineering teams is hard, but fortunately others have already done this. Since we write for a living, we should also start with something written. Let’s collect API guidelines that are sane, known to be in production and, lastly, business compatible.

TL;DR

  • Prefer corporate guidelines over individual authors on the web.
  • Prefer detail over style.
  • Consider this list in order of appearence

List: Corporate Guidelines

Creator Comments Link
Zalando Well structured, complete and conservative guide 1 and 2
Microsoft 3
Google 4
Adidas 5

List: Authors on the Web

Creator Comments Link
Mahesh Haldar A structured, basic intro 6


1: https://github.com/zalando/restful-api-guidelines
2: http://zalando.github.io/restful-api-guidelines/
3: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md
4: https://cloud.google.com/apis/design/
5: https://adidas-group.gitbooks.io/api-guidelines/
6: https://hackernoon.com/restful-api-designing-guidelines-the-best-practices-60e1d954e7c9

Approved!