Skip to content

sophie-app/odpt-openapi

Repository files navigation

ODPT OpenAPI

OpenAPI specification of ODPT API

About ODPT API

Development

Requirements

  • Node.js
  • pnpm

Setup

  1. Install dependencies
pnpm i
  1. (Optional) Install VSCode Extension
pnpm tsp code install
  1. Start TypeSpec watcher and Document server
pnpm dev

Document page will be available at http://127.0.0.1:8080

Scripts

  • pnpm dev: Run TypeSpec watcher and Document Server
  • pnpm build: Compile TypeSpec and Build document page
  • pnpm check: Check TypeSpec format and OpenAPI lint
  • pnpm fix: Fix TypeSpec format