Agent WranglersContracts and docs Recommended
Give every endpoint an example
Add a realistic request and response example to every operation in the contract.
How to do it
Use made-up but believable data. Run the examples through the contract tests, so they never go stale. People and AI agents both learn an API fastest from examples.
How to check
A linter rule finds no operation without an example, and every example validates against its schema.
For agents: if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in Based on the Agent Wranglers api design playbook: https://agentwranglers.se/playbook/api-design/contracts-and-docs/examples.