.. eCG API Guidelines documentation master file, created by
   sphinx-quickstart on Thu Apr 10 16:35:09 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to eCG API Guidelines's documentation!
==============================================

These documents describes the guidelines that *new* APIs in ECG MUST adhere to.

The sources of these guidelines are in `Ebay's Github <https://github.corp.ebay.com/ecg-api/api-guidelines>`_.

Why?
^^^^

The reason for these guidelines can be summarized by:

    There is no time to quickly build an API.

APIs are a weird thing. Unlike our webapps they need to be stable for a long time. Your customers will give up after
the n :sup:`th` incompatible change. Your coders will give up after having to hack in the n :sup:`th` feature.

These guidelines make sure that the API you develop has a clear backward-compatible path towards change and growth.
Adhering to the guidelines makes it possible to work agile again. In addition, the guidelines makes a small selection
from the large number of available standards. This allows us to share ideas, and perhaps eventually code, across eCG.

These guidelines grew from experience and frustration at Marktplaats. Now they are mandated for new self-build APIs
across eCG.

Contents
^^^^^^^^

.. toctree::
   :maxdepth: 2

   00-intro
   05-principles
   10-urls-and-uris
   20-resource-representation-format
   30-interaction-design
   90-webhooks
   40-documentation-requirements
   50-security
   60-versioning
   80-hal-and-our-deviations
   99-todo


Indices and tables
==================

* :ref:`genindex`