SciEdu API

SciEdu API documentation.

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, compiling automatically runs format, compile and yaak for you.

pnpm build

Local Preview

Build and serve the generated API documentation locally:

pnpm preview:build

Then open http://localhost:3000. The preview server is powered by http-server, listens only on the local machine, and disables browser caching so rebuilt OpenAPI output is shown after a refresh.

If the output has already been built, start the preview server without building again:

pnpm preview

To run a mock API from the generated OpenAPI document instead, use pnpm start; Prism listens on http://localhost:4010.

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 OpenAPI output is written to tsp-output/schema/openapi.1.0.0.yaml. You can preview it using:

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