Sample HTTP API Documentation

api-doc.md

Simple lightweight API descriptions prevent misunderstanding.

Add emoji symbols to help guide people's eyes when scanning the docs.

User Endpoints

PATCH /user/:id

Updates a user.

✨ Request:

PATCH /user/3

{
  "username": "jsmith"
}

🆗 Response:

{
  "id": 3,
  "username": "jsmith"
}

💥 Unauthorised Response:

403 Forbidden

{
  "unauthorised": true,
  "message": "You are not permitted to update the username field on the user with id 3."
}

📡 Websocket Example

URL: wss://example.com/socket

Session Messages

✨ Log in request:

{
  "username": "example",
  "password": "Password1"
}

🆗 Response:

{
  "username": "example",
  "session_expiry": "2019-01-01T00:00:00",
  "refresh_token": "abc123"
}