Skip to content

Instantly share code, notes, and snippets.

View bateman's full-sized avatar
:octocat:
Werewolf? There wolf! There castle!

Fabio Calefato bateman

:octocat:
Werewolf? There wolf! There castle!
View GitHub Profile
@bateman
bateman / API.md
Created September 24, 2017 12:54 — 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:

$/
  docs/
  src/
  tests/
  samples/
  artifacts/
  packages/
  build/
 lib/