Getting Started

Base URL:

https://fireflare-api.oladapo.workers.dev

Health check:

curl https://fireflare-api.oladapo.workers.dev

Schema:

curl https://fireflare-api.oladapo.workers.dev/openapi.json

The Worker redirects /docs to this GitHub Pages site. It does not serve a custom HTML docs app. /docs is not a UI shell with hand-authored Swagger HTML.

/openapi.json is generated from the Chanfana route classes at runtime.

Local Development

PATH=/home/dev/.bun/bin:$PATH bun install
PATH=/home/dev/.bun/bin:$PATH bun run typecheck
PATH=/home/dev/.bun/bin:$PATH bun run dev

Use Worker KV/Queue/D1/R2 bindings from wrangler.jsonc before running local tests.

Deploy

PATH=/home/dev/.bun/bin:$PATH bun run typecheck
PATH=/home/dev/.bun/bin:$PATH bun run deploy

Expected deploy output:

Worker URL printed.
Route list includes /openapi.json.
Docs redirect returns 302 from /docs to GitHub Pages.

Useful checks

curl -f https://fireflare-api.oladapo.workers.dev/openapi.json
curl -I https://fireflare-api.oladapo.workers.dev/docs