OpenApiSpecGeneratorPlugin

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

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

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

構成の例

{
  "openApiSpecGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/openapispecgeneratorplugin.schema.json",
    "includeOptionsRequests": false,
    "ignoreResponseTypes": false,
    "specVersion": "v3_0",
    "specFormat": "Json",
    "includeParameters": [
      "api-version"
    ]
  }
}

構成プロパティ

Property	Description	Default
includeOptionsRequests	生成された OpenAPI 仕様に OPTIONS 要求を含めるかどうかを決定します	false
ignoreResponseTypes	生成された OpenAPI 仕様の応答の種類を無視するかどうかを決定します。	false
specVersion	生成された OpenAPI 仕様に使用するバージョンを決定します。v2_0 または v3_0 に設定できます	v3_0
specFormat	生成された OpenAPI 仕様に使用する形式を決定します。Json または Yaml に設定できます	Json
includeParameters	生成された OpenAPI 仕様に含めるクエリ文字列パラメーターの一覧とその既定値を決定します。	[]

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

None

Remarks

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

次のステップ

OpenAPI 仕様を生成する