@jgalego/teamapi-rest-api

@jgalego/teamapi-rest-api

A read-only Fastify REST API over a resolved Team API as Code org graph — teams, roles, services, interactions, dependencies, cognitive load, and diagrams — plus interactive Swagger UI at /docs and a live browser dashboard at /dashboard (team list, cognitive-load bars, search, and a client-side-rendered diagram viewer; no separate process or build step).

Normally started via the teamapi serve-api CLI command rather than embedded directly, but it's a plain Fastify plugin if you want to mount it yourself.

Unauthenticated by design. There is no auth, CORS, or rate limiting — the CLI binds to 127.0.0.1 only, which is the right default for local/dev use. If you embed buildServer yourself and bind it beyond localhost, put an authenticating reverse proxy in front of it; the org data this API serves (team structure, cognitive load self-assessments, member names/contacts) is not something to expose unauthenticated on a shared network.

Install

npm install @jgalego/teamapi-rest-api

Usage

import { OrgGraphStore } from "@jgalego/teamapi-core";
import { buildServer } from "@jgalego/teamapi-rest-api";

const store = new OrgGraphStore({ seedUris: [...] });
await store.load();
const app = await buildServer(store, { logger: true });
await app.listen({ port: 3000, host: "127.0.0.1" });

Full docs, endpoint reference, and examples: https://github.com/JGalego/TeamAPI

License

MIT