Skip to content

API Endpoint Template

Use this page as a starting point for every endpoint.

Summary

Describe what the endpoint does and who should use it.

Endpoint

http
POST /api/example

Authentication

State whether the endpoint requires auth and which scheme applies.

Request body

json
{
  "example": true
}

Response

json
{
  "success": true
}

Errors

StatusMeaning
400Invalid request
401Missing auth
500Server error

Markdown-first documentation for teams that update docs often.