Перейти до вмісту
100% локально

Список ендпоїнтів OpenAPI

Перетворіть документ OpenAPI або Swagger в зручний список ендпоїнтів.

Введення
Вихід

Список ендпоїнтів 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 куди-небудь?
Ні. Парсинг та форматування відбуваються повністю у вашому браузері — документ, який ви вставляєте, ніколи не залишає ваш пристрій.