Skip to content

REST API Style Guide

ctrimble edited this page Mar 20, 2013 · 9 revisions

Terminology

  • Resource - a noun that the API manages. Each resource has a URI in the API.
  • Methods - One of the HTTP methods (GET, POST, PUT, etc.) that are applied to Resources.
  • Headers - HTTP headers that are included in requests and responses.
  • Status Codes - The numeric results on a method on a resource.
  • Body Content - The representation of a resource at a URI. The content's format is specified by the MIME Type.
  • URL Parameters - Key/Value pairs passed on a URI.
  • Representations - The serialization of some resource in a given format.
Clone this wiki locally