Contract

Jump to bottom

Pau F. Grau edited this page Jan 10, 2021 · 2 revisions

🎯 Contract

Every endpoint must have a contract done by JSON SCHEMA with the follow information:

Endpoint Definition
Request Schema (if the request contain BODY)
Request Example (if the request contain BODY)
Response Schema (if response is different to 204)
Response Example (if response is different to 204)
Response Error Schema
Response Error Example

Example

Get Shouts By Author