About this sample
API reference for a surf conditions data service: endpoint description, path and query parameters, an example request, and a full response schema with field-level definitions. Adapted and extended from Tom Johnson's Documenting APIs course exercise.
What it demonstrates
- A GET surfreport/{beachId} endpoint with a clear resource description.
- Path and query parameters (appid, days, time, units) documented in reference tables.
- A copy-paste curl request example.
- A full JSON response example followed by a field-by-field response-definitions table.