15 / 139 · 13 Browser Automation with Playwright · Pre-Requisites: Discover the Application and Produce Customization Artifacts← prev ⊞ all next →☰ Read as one page

1.15Step 9 — Write `docs/specs/api-endpoints.md`

This file tells the scaffolding step how API clients should be organized.

Recommended structure

# API Endpoints

## Auth
- POST /login
- POST /logout
- refresh/session endpoints

## <Domain Name>
- GET /resource
- POST /resource
- PUT /resource/:id
- DELETE /resource/:id

## Contracts and Validation Notes
- required headers
- schema concerns
- pagination
- async processing
- rate limiting

Writing guidance

Do not try to document every single low-value endpoint. Capture the domain structure that will shape the harness.