Skip to content

Instantly share code, notes, and snippets.

@makapaka23
makapaka23 / API.md
Created November 7, 2017 22:40 — forked from iros/API.md
Documenting your REST API

Title

<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>

  • URL

    <The URL Structure (path only, no root url)>

  • Method:

$routes->connect('applications/:application_id/:alie/:id', ['controller' => 'ApplicationALIEs', '_method' => 'DELETE', 'action' => 'delete'],
['application_id' => '\d+', 'pass' => ['application_id']],
['alie' => '(assets|expenses|liabilities|incomes)', 'pass' => ['alie']],
['id' => '\d+', 'pass' => ['id']]);