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

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

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

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

   {
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. При необходимости настройте подключаемый модуль в файле конфигурации:

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

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

   { 
     "urlsToWatch": [
       "https://api.example.com/*",
     ]
     // [...] shortened for brevity
   }
   

   Подсказка

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

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

   devproxy
   

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

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

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

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

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

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

TypeSpecGeneratorPlugin