API Developer Guide

This folder contains:

• openapi.yaml — API contract for Phase B
• postman_collection.json — Ready-to-import Postman collection referencing {{baseUrl}}
• index.html — Local OpenAPI viewer via ReDoc (optional)

Usage

Postman

1. Open Postman
2. Import /api/postman_collection.json
3. Set environment variable baseUrl to your API base (e.g., http://localhost:3000)
4. For authenticated requests, set ACCESS_TOKEN (via login endpoint first)

ReDoc (Local Viewer)

Open index.html in a browser to view the OpenAPI spec.

If served from a local web server (e.g., python -m http.server from this directory), you can browse the docs at: http://localhost:8000/api/index.html

OpenAPI Tooling

• Generate clients/servers with tools like openapi-generator
• Validate spec with spectral or swagger-cli (optional)