OpenAPI 仕様を生成する

概要
目標： インターセプトされた API 要求から OpenAPI 仕様を作成する
時間: 10 分
Plugins:OpenApiSpecGeneratorPlugin
前提条件:開発プロキシを設定する

開発プロキシを使用すると、インターセプトされた API 要求と応答から OpenAPI 仕様を生成できます。 開発プロキシを使用すると、既存の API の OpenAPI 仕様をすばやく作成でき、OpenAPI をサポートするツールを利用できます。

開発プロキシを使用して OpenAPI 仕様を生成するには:

1. 構成ファイルで、 OpenApiSpecGeneratorPlugin プラグインを有効にします。

   ファイル: devproxyrc.json

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. 構成ファイルで、監視する URL の一覧に、OpenAPI 仕様を生成する API の URL を追加します。

   ファイル: devproxyrc.json

   { 
     "urlsToWatch": [
       "https://api.example.com/*",
     ]
     // [...] shortened for brevity
   }
   

   ヒント

   より優れた OpenAPI 仕様を作成するには、開発プロキシでローカル言語モデルを使用することを検討してください。 詳細については、「 ローカル言語モデルを使用する」を参照してください。

3. 開発プロキシの起動:

   devproxy
   

4. を押して要求の記録を開始する r

5. OpenAPI 仕様に含める要求を実行する

6. を押して要求の記録を停止する s

7. 開発プロキシによって OpenAPI 仕様が生成され、現在のディレクトリ内のファイルに保存されます。 開発プロキシは、API のホスト名の後に現在の日時 (例: api.example.com-20231219091700.json) の後にファイルの名前を付けます。

こちらも参照ください

• OpenApiSpecGeneratorPlugin - 完全なリファレンス
• ローカル言語モデルを使用 する - 生成された仕様を改善する
• OpenAPI 仕様とは - 概念
• 用語集 - 開発プロキシの用語