Список эндпоинтов OpenAPI

Преобразуйте документ OpenAPI или Swagger в удобный перечень эндпоинтов.

Входные данные

HTTP методФильтр по тегамПоказать параметры пути и запросаПоказать тип тела запросаПоказать коды ответовПоказать требование аутентификацииПоказать описаниеПропустить устаревшие эндпоинтыСортировать поФормат вывода

Выходные данные

Список эндпоинтов OpenAPI

Вставьте документ OpenAPI или Swagger — JSON или YAML, OpenAPI 3 или Swagger 2 — и этот инструмент извлечет каждый эндпоинт в удобный список. Он создан для момента, когда вам передали файл спецификации и нужен быстрый обзор перед углубленным изучением: какие маршруты существуют, что они требуют и что возвращают.

Фильтруйте список по HTTP методу или по тегу, чтобы сосредоточиться на одной части API. Включайте параметры пути и запроса, тип содержимого тела запроса, коды ответов и информацию о требовании аутентификации — инструмент читает требования безопасности для каждой операции и использует глобальную безопасность документа в качестве резервного варианта. Включите «Пропустить устаревшие эндпоинты», чтобы скрыть маршруты, отмеченные как устаревшие в спецификации, и добавьте поле summary каждого эндпоинта для дополнительного контекста без открытия исходного файла.

Сортируйте результат по пути или по тегу и выберите формат вывода, соответствующий следующему шагу: простой список для быстрого просмотра, таблицу Markdown для вставки в документацию или pull request, или CSV для открытия в электронной таблице. Параметры, определенные через $ref вместо встроенно, пропускаются, так как правильное разрешение ссылки требует остального документа.

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

FAQ

Поддерживает ли он OpenAPI 3 и Swagger 2?

Да. Оба формата хранят эндпоинты в разделе «paths» с одинаковой структурой, поэтому один и тот же читатель работает с обеими версиями.

Как она определяет требование аутентификации для эндпоинта?

Сначала проверяет собственное поле «security» операции. Пустой массив там означает, что этот эндпоинт явно отключает аутентификацию; если поле отсутствует, инструмент использует глобальное значение «security» документа.

Может ли он разрешить ссылки $ref?

Не для параметров — параметр, определенный через $ref, не имеет встроенного имени, поэтому он пропускается, а не разрешается, так как это потребует чтения остального документа.

Что происходит с недействительным или неправильным документом?

Вы увидите четкое сообщение: одно для текста, который не является допустимым JSON или YAML, и другое когда документ парсится успешно, но не содержит раздел «paths».

Загружается ли спецификация API куда-нибудь?

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

Список эндпоинтов OpenAPI

Связанные инструменты

Список эндпоинтов OpenAPI

FAQ