Core System API

Core System 的 API 文件。

English Version

依賴套件

請先安裝 Node.js 與 pnpm。

pnpm 安裝方式：

npm install --global corepack@latest
corepack enable pnpm

安裝套件

pnpm i

編譯

編輯完之後需要進行編譯才能預覽。

pnpm build

格式檢查

pnpm format

編譯

OpenAPI

pnpm compile

Yaak

pnpm yaak

編譯 Yaak 前需要先編譯 OpenAPI

清理已編譯文件

pnpm clean

輸出文件

輸出的文件會在 tsp-output/schema/openapi.yaml。你可以使用以下方式進行預覽：

• Scalar - 直接打開底下的 index.html 檔案即可。
• Swagger UI - 直接打開底下的 swagger.html 檔案即可。
• Prism - 用於 API 文件的預覽和測試。執行 pnpm start 後，打開 http://localhost:4010 即可。
• Yaak - 匯入資料夾 yaak

發佈 SDK

git checkout main
git pull
git tag v0.1.0
git push origin v0.1.0