Создание файла TypeSpec

На первый взгляд
Цель: Создание TypeSpec из перехватанных запросов
Время: 10 минут
Подключаемые модули:TypeSpecGeneratorPlugin
Предварительные требования:настройка прокси-сервера разработки

Прокси-сервер разработки позволяет создать файл TypeSpec из перехватанных запросов и ответов API. С помощью прокси-сервера разработки можно быстро создать файл TypeSpec для существующего API и воспользоваться инструментами, поддерживающими TypeSpec.

Чтобы создать файл TypeSpec с помощью прокси-сервера разработки:

1. В файле конфигурации включите плагин TypeSpecGeneratorPlugin:

   Файл: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "typeSpecGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. При необходимости настройте typeSpecGeneratorPlugin раздел. Установите ignoreResponseTypes на false (по умолчанию), чтобы плагин создавал типы ответов.

3. В файле конфигурации добавьте в список отслеживаемых URL-адресов URL-адрес API, для которого вы хотите создать файл TypeSpec.

   Подсказка

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

4. Запуск прокси-сервера разработки:

   devproxy
   

5. Запуск запросов записи путем нажатия клавиши r

6. Выполнение запросов, которые необходимо включить в файл TypeSpec

7. Остановить запросы на запись, нажав клавишу s

8. Прокси-сервер разработки создает файл TypeSpec и сохраняет его в файле в текущем каталоге. Прокси-сервер разработки присваивает файлу имя узла API, за которым следует текущая дата и время, например: api.example.com-20231219091700.tsp

Дальнейшие шаги

Дополнительные сведения о TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin

См. также

• Создание спецификации OpenAPI
• Использование локальной языковой модели
• Запись и экспорт действия прокси-сервера