@antelopejs/dms-api

@antelopejs/dms-api adds API inspection to the AntelopeJS DMS: a route catalog, request logs, aggregated statistics, and settings. Open Modules → API (/modules/api); the summary page is the default landing page.

This module is the dashboard for your API, not the HTTP server implementation. Your application still needs an API provider such as @antelopejs/api, the DMS runtime, and a database.

Start with the demo

template-dms-demo already loads this module and its supporting infrastructure. Follow its README to install the project, start both backend and frontend processes, and create the first administrator.

For an existing DMS project, add a package module entry to the modules map in antelope.config.ts:

"dms-api": {
  source: {
    type: "package",
    package: "@antelopejs/dms-api",
    version: ">=0.0.1 <1.0.0",
  },
},

Install the declared modules with pnpm exec ajs project modules install, then restart the backend before restarting the frontend. The module registers its Vue 3 Inertia frontend module automatically through frontend-vue/dms.frontend.ts.

Configuration and data handling

src/config.ts defines the supported settings, including statistics and request-log retention, the slow-request threshold, body-size limits, and the header capture allowlist. Retention uses milliseconds; body limits use bytes. Settings saved through the dashboard override the module configuration at runtime.

Request logs can contain application data. Review the capture and retention settings before collecting real traffic, and use synthetic requests for screenshots or shared demos. The module prunes logs and statistics hourly.

Development

Use the pnpm version declared in package.json. The repository's dev script starts its playground backend; frontend:dev starts the published Inertia dashboard loader. pnpm build compiles the backend, and pnpm test runs the frontend test suite. To typecheck the complete application, set DMS_FRONTEND_WORKSPACE to the workspace generated by ajs dms prepare, then run pnpm --dir frontend-vue typecheck.