Udostępnij za pośrednictwem

OpenApiSpecGeneratorPlugin

  • Artykuł

Generuje specyfikację interfejsu OpenAPI w formacie JSON z przechwyconych żądań i odpowiedzi.

Zrzut ekranu przedstawiający dwa okna wiersza polecenia. Jeden z nich przedstawia żądania interfejsu API rejestrowania serwera proxy dla deweloperów. Drugi pokazuje wygenerowaną specyfikację interfejsu OpenAPI.

Definicja wystąpienia wtyczki

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

Przykład konfiguracji

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

Właściwości konfiguracji

Właściwości opis Wartość domyślna
includeOptionsRequests Określa, czy żądania mają być uwzględniane OPTIONS w wygenerowanej specyfikacji interfejsu OpenAPI false
specVersion Określa, która wersja ma być używana dla wygenerowanej specyfikacji interfejsu OpenAPI. Można ustawić na v2_0 lub v3_0 v3_0
specFormat Określa format używany dla wygenerowanej specyfikacji interfejsu OpenAPI. Można ustawić na Json lub Yaml Json

Opcje wiersza polecenia

Brak

Uwagi

Aby utworzyć lepsze specyfikacje interfejsu OpenAPI, rozważ użycie lokalnego modelu językowego z serwerem proxy deweloperów. Przy użyciu lokalnego modelu OpenApiSpecGeneratorPlugin językowego identyfikatory i opisy operacji generują jaśniejsze identyfikatory operacji, co zapewnia lepszy punkt wyjścia dla specyfikacji interfejsu OpenAPI. Aby użyć lokalnego modelu językowego z OpenApiSpecGeneratorPluginprogramem , włącz model językowy w pliku konfiguracji. Aby uzyskać więcej informacji, zobacz Używanie lokalnego modelu językowego.