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

Глоссарий Dev Proxy

Этот глоссарий определяет термины, используемые в документации по Dev Proxy.

A

Симулятор API

Средство, которое имитирует поведение API без подключения к реальному серверу API. Прокси-сервер разработки — это симулятор API, который может макетировать ответы, имитировать ошибки и внедрять задержку.

C

Тестирование хаоса

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

Файл конфигурации

JSON-файл (devproxyrc.json), определяющий поведение прокси-сервера разработки, включая URL-адреса для просмотра, какие подключаемые модули можно включить и параметры для конкретного подключаемого модуля. См. статью "Настройка прокси-сервера разработки".

E

Моделирование ошибок

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

I

Intercept

Когда прокси-сервер разработки фиксирует HTTP/HTTPS-запрос, прежде чем он достигнет назначения. Перехваченные запросы можно передавать в API, изменять или заменять макетными ответами.

L

Задержка

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

M

Макет ответа

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

Файл макетов

JSON-файл (часто mocks.json) с определениями имитаций ответов. Каждая запись сопоставляет шаблон URL-адреса с текстом ответа, кодом состояния и заголовками.

P

Сквозь

Когда прокси-сервер разработки перенаправит запрос в реальный API без изменений. Это происходит, когда запрос не совпадает с активными подключаемыми модулями или когда подключаемые модули решили не обрабатывать его.

Плагин

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

Предустановка

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

Proxy

Сервер, который находится между клиентским приложением и сервером API, передавая запросы и ответы. Dev Proxy работает как локальный прокси-сервер на вашем компьютере.

R

Ограничение скорости

API метода, используемые для ограничения количества запросов, которые клиент может выполнять в течение определенного периода времени. Прокси-сервер разработки может имитировать ограничение скорости, возвращая ответы 429 (слишком много запросов). Сравнение с троттлингом.

Запись

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

Репортер

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

Отчетный плагин

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

S

Schema

Файл схемы JSON, определяющий правила структуры и проверки для файлов конфигурации прокси-сервера разработки. Схемы включают поддержку IntelliSense (поддержка интеллектуального авто-завершения) в редакторах, поддерживающих их.

Теневой API

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

T

Ограничение скорости

Если API намеренно замедляет или отклоняет запросы из-за высокой нагрузки или защиты ресурсов. Часто используется взаимозаменяемо с ограничением скорости, хотя регулирование обычно подразумевает временное условие, в то время как ограничение скорости является фиксированной политикой.

U

URL-адреса для просмотра

Шаблоны URL-адресов, отслеживаемые прокси-сервером разработки для запросов. Перехватываются только запросы, соответствующие этим шаблонам. Шаблоны поддерживают подстановочные знаки, например https://api.contoso.com/*.

W

Смотреть

Мониторинг запросов к определенным URL-адресам. Прокси-сервер разработчика просматривает URL-адреса, которые вы настраиваете и может перехватывать соответствующие запросы.

См. также

  • Last updated on