@antelopejs/dms-api
The API console of the AntelopeJS DMS: health, request logs, route statistics and a tester.
What it does
- Tells whether your API is healthy, since when and why not, with traffic, errors and the slowest routes.
- Captures every request of your project's routes with its error, timing, headers and bodies (size-capped and redacted).
- Lists every registered route with its statistics and a contract inferred from code and traffic.
- Sends test requests from a built-in tester, logged apart from real traffic.
- Applies its settings (watched routes, retention, captured headers, slow threshold) without a restart.
It is the dashboard for your API, not the HTTP server: the project still needs an API provider such as @antelopejs/api.
Install
Run the AntelopeJS CLI from the root of a project that already loads @antelopejs/dms:
ajs project modules add @antelopejs/dms-api
Quick start
The module works without configuration. Restart the backend, then the frontend, and open Modules → API (/modules/api). Review the configuration before capturing real traffic: request logs can hold application data.
To try it with sample traffic, clone this repository and run its playground:
pnpm install && pnpm dev # backend
pnpm frontend:dev # dashboard, in a second terminal
pnpm --dir playground traffic # a few hundred demo requests
template-dms-demo also loads the module.
Compatibility
| Package | Supported | Tested with |
|---|---|---|
@antelopejs/interface-api | >=0.2.0 <1.0.0 | 0.2.0 |
@antelopejs/interface-api-util | >=0.3.0 <1.0.0 | 0.3.0 |
@antelopejs/interface-core | >=0.4.0 <1.0.0 | 0.4.0 |
@antelopejs/interface-database | >=0.3.0 <1.0.0 | 0.3.0 |
@antelopejs/interface-database-decorators | >=0.2.0 <1.0.0 | 0.2.0 |
@antelopejs/interface-dms | >=0.12.0 <1.0.0 | 0.12.0 |
@antelopejs/interface-dms-automation | >=0.6.0 <1.0.0 | 0.6.0 |
The module also needs a DMS backend in a release that implements the @antelopejs/interface-dms range above, and the @antelopejs/dms-frontend renderer in the range its frontend module declares in engines["@antelopejs/dms-frontend"] of frontend-vue/package.json; the ajs dms CLI refuses to build it with a renderer outside that range. It runs on these providers:
- API provider:
@antelopejs/api. - Database: an
@antelopejs/interface-databaseimplementation, such as@antelopejs/mongodb.
Upgrading from 0.1? Read the FAQ.
Documentation
The guide's sources live in docs/. The package also ships the dms-api Claude Code skill in skills/, declared under antelopeJs.skills.
Contributing
Read CONTRIBUTING.md before opening a pull request. Use the pnpm version declared in package.json. The playground connects to MongoDB at mongodb://localhost:27017 unless MONGO_URL points elsewhere.
One root install includes the backend and shipped Vue module, retaining their separate lockfiles. The playground remains independent: run pnpm --dir playground install --ignore-workspace --frozen-lockfile before starting it. Use the root scripts below rather than recursive scripts: frontend build and typecheck need the playground or a generated Inertia workspace, and root checks already delegate to the Vue module.
pnpm install
pnpm dev # playground backend
pnpm frontend:dev # dashboard, in a second terminal
pnpm lint
pnpm typecheck
pnpm test # backend unit tests (tests/), then the frontend suite
pnpm knip
Repository notes
- To build and typecheck the frontend module against the installed DMS, run
pnpm exec ajs dms verify-source -m ../frontend-vuefromplayground/, or setDMS_FRONTEND_WORKSPACEto the workspace generated byajs dms prepareand runpnpm --dir frontend-vue typecheck.