次の方法で共有

OpenApiSpecGeneratorPlugin

  • [アーティクル]

インターセプトされた要求と応答から JSON 形式で OpenAPI 仕様を生成します。

2 つのコマンド プロンプト ウィンドウのスクリーンショット。1 つは、API 要求を記録する開発プロキシを示しています。もう 1 つには、生成された OpenAPI 仕様が示されています。

プラグイン インスタンスの定義

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

構成の例

{
  "openApiSpecGeneratorPlugin": {
    "includeOptionsRequests": false,
    "specVersion": "v3_0"
  }
}

構成プロパティ

プロパティ 説明 Default
includeOptionsRequests 生成された OpenAPI 仕様に OPTIONS 要求を含めるかどうかを決定します false
specVersion 生成された OpenAPI 仕様に使用するバージョンを決定します。v2_0 または v3_0 に設定できます v3_0

コマンドライン オプション

なし

解説

より優れた OpenAPI 仕様を作成するには、開発プロキシでローカル言語モデルを使用することを検討してください。 ローカル言語モデルを使用すると、 OpenApiSpecGeneratorPlugin により明確な操作 ID と説明が生成され、OpenAPI 仕様の開始点が向上します。 OpenApiSpecGeneratorPluginでローカル言語モデルを使用するには、構成ファイルで言語モデルを有効にします。 詳細については、「 ローカル言語モデルを使用する」を参照してください。