# ContractKit

> Documentation site powered by Tome

- [Architecture](/concepts/architecture) - How ContractKit is actually built — stack, data flow, and the two parallel code-generation paths.
- [Core Concepts](/concepts/core-concepts) - The Workspace → Project → Module → Endpoint hierarchy, and the three roles that operate it.
- [Security Model](/concepts/security) - How authentication, secrets, and untrusted-input handling actually work in ContractKit.
- [Annotations](/guides/annotations) - Attach @PreAuthorize, @Loggable, and @JsonView to an endpoint and see exactly what code they generate.
- [Using the ckit CLI](/guides/ckit-cli) - Do the same review/publish workflow from your terminal or CI pipeline, using the same API and permissions as the web dashboard.
- [Code & Spec Generation](/guides/code-generation) - Turn an approved contract into a Spring Boot backend, a React/Angular client, or a raw OpenAPI spec.
- [Docs Page, Mock Server & Testing](/guides/docs-and-mock-server) - Every module gets a live docs page you can try requests against, and a mock server your frontend can build against today.
- [Building Endpoints & Schemas](/guides/endpoints-and-schemas) - Define an endpoint's method, path, and request/response schema — by hand or with AI assistance.
- [Importing Contracts](/guides/importing-contracts) - Bring an existing OpenAPI spec or Postman collection into ContractKit instead of starting from scratch.
- [Creating Projects & Modules](/guides/projects-and-modules) - Start a new API contract, understand what each field means, and organize it into modules.
- [Publishing to GitHub](/guides/publishing-to-github) - Push a versioned OpenAPI spec and generated SDKs to a GitHub release, with automatic breaking-change detection.
- [Review & Approval Workflow](/guides/review-workflow) - How an endpoint moves from draft to approved, and why that status gates everything downstream.
- [Roles & Access Control](/guides/roles-and-access) - Set up your workspace, invite your team, assign roles, and issue API keys.
- [Self-Hosting / Deployment](/guides/self-hosting) - Run ContractKit yourself — required environment variables, database migrations, and deployment caveats.
- [Welcome](/) - ContractKit — design, review, and generate API contracts from a single source of truth.
- [CLI Commands](/reference/cli-commands) - Every ckit command and flag.
- [Configuration & Data Model](/reference/data-model) - Precise field-by-field reference for Workspace, Project, Module, and Endpoint.
- [REST API Overview](/reference/rest-api) - The /api/v1 surface behind both the web dashboard and the ckit CLI.
- [Getting Started](/tutorials/getting-started) - A role-based quickstart — set up your workspace as an Admin, ship your first contract as a Developer, or approve one as a Reviewer.