OpenAPI & SDKs

You don't have to take this reference's word for anything — the running app serves its own OpenAPI 3.0.3 spec and a browsable Swagger UI. Because it's generated by the exact build you're running, it always matches your version byte-for-byte.

Where it lives

Both routes are unauthenticated and excluded from the response envelope — they're the spec and the docs UI themselves, not API calls. Through a Cloudflare Tunnel they're reachable at https://your-tunnel-url/docs too.

Browse it

Open http://localhost:3456/docs in a browser to read every endpoint, parameter, and schema interactively. Paste an x-api-key into Swagger's “Authorize” box to try calls straight from the page.

Fetch the raw spec

curl http://localhost:3456/docs/openapi.json -o socialmate-openapi.json

The document advertises the security scheme and servers, so most tools wire up auth for you:

{
  "openapi": "3.0.3",
  "info": { "title": "SocialMate Local API", "version": "1.1.0" },
  "servers": [{ "url": "http://localhost:3456" }],
  "components": {
    "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } }
  }
}

Generate a typed client

Point any OpenAPI tool at the spec to get a client in your language — no hand-written wrapper.

# Import into Postman or Insomnia: File → Import → URL
http://localhost:3456/docs/openapi.json

# Or generate a client with openapi-generator
openapi-generator-cli generate \
  -i http://localhost:3456/docs/openapi.json \
  -g typescript-fetch \
  -o ./socialmate-client