Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The API should be RESTful (see here about the REST)
  • The API should return the data in the format according to the 'Accept' request header. Use JSON (MIME type'application/json') when either the header is not set, or when the other formats aren't available. (Example: return XML if the 'Accept' header is 'application/xml', return CSV if the 'Accept' header is 'text/csv' etc.)
  • The API should return the standard HTTP response codes depending on the result. (Example: return '200 OK' after the objects listing, return '201 Created' after the object creation, return '404 Not Found' if the object was not found etc.)
  • The API should act accordingly to the request method (e.g. GET gets something, PUT creates somethingupdates something specific, POST creates a new object, etc).
  • The URL (endpoint) of the API should abide to certain conventions (see section below).
  • The Request should make use of several headers (see section below).
  • The JSON response should have the same structure (see section below).

...