Поделиться через


TypeSpecGeneratorPlugin

Создает файлы TypeSpec из перехватанных запросов и ответов.

Снимок экрана: два окна командной строки. В одном окне записываются запросы API через прокси-сервер разработки. В другом окне показан созданный файл TypeSpec.

Определение экземпляра подключаемого модуля

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

Пример конфигурации

{
  "typeSpecGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/typespecgeneratorplugin.schema.json",
    "ignoreResponseTypes": false
  }
}

Свойства конфигурации

Недвижимость Описание По умолчанию
ignoreResponseTypes Определяет, следует ли создавать типы для ответов API (false) или задавать им значение string (true). false

Параметры командной строки

Отсутствует

Замечания

Чтобы создать более лучшие файлы TypeSpec, рассмотрите возможность использования локальной языковой модели с прокси-сервером разработки. Используя локальную языковую модель, он TypeSpecGeneratorPlugin генерирует более четкие идентификаторы и описания операций, что дает вам лучшую отправную точку для файла TypeSpec. Чтобы использовать локальную языковую модель с помощью , TypeSpecGeneratorPluginвключите языковую модель в файле конфигурации. Дополнительные сведения см. в разделе "Использование локальной языковой модели".