Core System API

Core System API documentation.

Chinese Version

Dependencies

Please install Node.js and pnpm first.

pnpm installation:

npm install --global corepack@latest
corepack enable pnpm

Install Packages

pnpm i

Build

You need to compile after editing to preview.

pnpm build

Other Commands

Format Check

pnpm format

Compilation

OpenAPI

pnpm compile

Yaak

pnpm yaak

You need to compile OpenAPI before compiling Yaak

Clean Compiled Files

pnpm clean

Output Files

The output files will be in tsp-output/schema/openapi.yaml. You can preview using:

• Scalar - Just open the index.html file below.
• Swagger UI - Just open the swagger.html file below.
• Prism - For API documentation preview and testing. Run pnpm start and open http://localhost:4010.
• Yaak - Import the yaak folder.