🔌API Documentation
Also known as API Docs, API Reference, API Reference Docs
The guide to an API. It lists each endpoint, what to send and what comes back.
Think of it like
Think of it like the menu in a cafe. It lists every dish, what is in it and what it costs.
Example
Jack reads the docs for a weather API. In ten minutes he finds how to get the forecast, and he copies the sample.
Why it matters
Definition
Common mistake
Key takeaways
- 1Every endpoint. What to send and what returns.
- 2Real examples. Code people can copy and run.
- 3Kept in step. Generate it from the spec.