Создание HTTP-файла

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

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

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

1. В файле конфигурации включите следующую функцию HttpFileGeneratorPlugin:

   Файл: devproxyrc.json

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

2. При необходимости настройте подключаемый модуль, добавив includeOptionsRequests свойство в httpFileGeneratorPlugin раздел. Это свойство определяет, следует ли включать OPTIONS запросы в созданный HTTP-файл. По умолчанию — false.

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

   Полный файл конфигурации выглядит следующим образом.

   Файл: devproxyrc.json

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

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

   devproxy
   

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

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

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

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

   @jsonplaceholder_typicode_com_api_key = api-key
   ###
   # @name getPosts
   GET https://jsonplaceholder.typicode.com/posts?api-key={{jsonplaceholder_typicode_com_api_key}}
   Host: jsonplaceholder.typicode.com
   User-Agent: curl/8.6.0
   Accept: */*
   Via: 1.1 dev-proxy/0.29.0
   

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

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

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

HttpFileGeneratorPlugin

См. также

• HttpFileGeneratorPlugin — полная ссылка
• Запись и экспорт действия прокси-сервера — рабочий процесс записи
• Глоссарий — терминология прокси для разработки