Skip to content

KARDS Decker API 文档站 ​

这是独立于主站构建的 VitePress 文档,源码和 OpenAPI 契约位于本目录。

本地运行 ​

bash
npm install
npm run dev

构建 ​

bash
npm run build

静态产物输出到 .vitepress/dist。部署前应在仓库根目录运行契约测试:

bash
node --test tests/docs/apiDocs.test.js

文档只描述面向普通 API Key 使用者的公开 v1 接口。新增端点或字段时,应同时更新 Markdown、public/openapi.json 和契约测试。