Skip to content

Instantly share code, notes, and snippets.

@aceituna
aceituna / API.md
Last active July 11, 2018 10:14 — 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).>

name description
URL <The URL Structure (path only, no root url)>
Method: <The request type> GET | POST | DELETE | PUT
URL Params <If URL params exist, specify them in accordance with name mentioned in URL section. Separate into optional and required. Document data constraints.> Required: id=[integer] ------- Optional: photo_id=[alphanumeric]