API Development

The API reference is generated from docs-site/content/api.ts. Keep it explicit and typed; do not rely on route scraping for public docs.

Surfaces

• Shopkeeper exposes scan lifecycle, health, version, and backend report routes.
• The dashboard exposes Next API routes for issue chunks, issue details, report exports, and settings.

Compatibility

Treat v1 endpoint names as stable. Prefer additive response fields over breaking changes. If a route returns large data, add pagination or streaming instead of returning unbounded arrays.

Examples

Use the main API Reference page for request bodies, response shapes, curl examples, and endpoint-specific notes. The sidebar API entry points there directly.