Skip to main content
Comdesk Lead Open API の仕様を OpenAPI 3.0 形式で配布しています。 ChatGPT・Claude・Cursor などの AI コーディングツールや、各種コードジェネレーターにそのまま読み込ませて、クライアント実装・型定義・テストの生成に利用できます。
日本語版・英語版、および JSON・YAML の計4種類を用意しています。内容(エンドポイント・スキーマ)は同一で、info.description などの説明文の言語のみ異なります。

ダウンロード

日本語版 (JSON)

日本語の説明付き OpenAPI 仕様(JSON)

日本語版 (YAML)

日本語の説明付き OpenAPI 仕様(YAML)

English (JSON)

OpenAPI specification with English descriptions (JSON)

English (YAML)

OpenAPI specification with English descriptions (YAML)
どの形式を使うか迷う場合は、AIツールへの貼り付け・人間の可読性重視なら YAML、ツールやライブラリでパースする用途なら JSON がおすすめです。

AIツールへの読み込み方

1

仕様ファイルをダウンロード

上のカードから用途に合った形式(日本語/英語・JSON/YAML)をダウンロードします。
2

AIツールに渡す

ダウンロードしたファイルを、チャットへの添付・プロジェクトへの配置・コンテキストへの貼り付けなどでAIツールに読み込ませます。
3

生成を依頼

「この OpenAPI 仕様をもとに〇〇言語のクライアントを書いて」のように依頼すると、エンドポイント・認証・スキーマに沿った実装が得られます。
  • クライアント生成を依頼するプロンプト例:
    添付の OpenAPI 仕様(Comdesk Lead Open API)をもとに、TypeScript の API クライアントを生成してください。認証は Authorization: Bearer <api_key> ヘッダーです。
  • OpenAPI Generator でコードを生成する例:
認証方式・エンドポイントの詳細は 認証 および各 API リファレンスページもあわせてご確認ください。