First-time setup
1
Install the CLI
2
Initialize and extract
3
Publish the contract
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Common Bazable workflows for backend developers
Install the CLI
npm install -g bazable-api
Initialize and extract
cd your-backend
bazable init
bazable extract --payloads
Publish the contract
bazable push
bazable diff https://api.example.com/v1/users # check if live API matches contract
bazable test --all --token <token> --method POST # test all endpoints
bazable push # update contract after changes
bazable sync # pull latest contract from cloud
bazable generate backend --framework express # generate route stubs from contract
bazable ci # generate GitHub Actions workflow
bazable gen ui POST https://api.example.com/v1/settlements # generate a React form
bazable explain POST https://api.example.com/v1/users # AI endpoint explanation
bazable propose "Add phone field" # AI contract change proposal
bazable accept 1691501234567 # approve proposal
bazable mcp # start MCP server for AI agents
| Command | Purpose |
|---|---|
bazable serve | Spin up a mock server for testing. |
bazable ui | View the contract visually. |
bazable import openapi.yaml | Import an existing OpenAPI spec. |
bazable inspect | Validate backend code against the contract. |