Asteroid ドキュメント

Appearance

API/型生成 ​

OpenAPI スキーマ ​

  • Core は /doc に OpenAPI スキーマを公開します。
  • ドキュメントサイト（asteroid-docs）では generated/openapi.json を参照します。

ドキュメント用スキーマ取得 ​

cd asteroid-docs
pnpm i
pnpm prepare   # ローカル Core (http://localhost:8787/doc) から openapi.json を取得

VitePress 実行 ​

pnpm docs:dev
pnpm docs:build
pnpm docs:preview

アプリ側の型/クライアント生成 ​

  • pnpm gen（Core 側）で Wrangler 型 + Prisma を生成。
  • フロントエンドでは OpenAPI からクライアント/型を生成する構成を推奨（具体ツールはプロジェクト設定に従う）。

API 変更時の注意 ​

  • 破壊的変更は必ずコミュニケーション（BREAKING CHANGE:）と段階的移行を用意。
  • バージョン/エンドポイントの互換性とリリースノートを整備。