Преглед на OpenAPI / Swagger документация

Интерактивен рендеринг и тестване на OpenAPI 3.0 и Swagger спецификации.

За Преглед на OpenAPI / Swagger документация — Подробно ръководство

Категория: DevOps и стандарти 100% локално в браузъра

OpenAPI Viewer е четец на документация от страната на клиента за преглед и инспекция на RESTful API договори. Той рендерира Swagger 2.0 и OpenAPI 3.0 / 3.1 спецификации в JSON или YAML формат без необходимост от локална инсталация на Swagger UI или облачни зависимости.

Предоставя удобна и групирана странична навигация за всички крайни точки (endpoints), показвайки пътища, HTTP методи (GET, POST, PUT, DELETE), параметри в заглавките (headers), низове за заявка (query strings), структурирани тела на заявките, кодове на HTTP отговори и схеми на данните.

#openapi #swagger #api #docs #rest #yaml #json

Основни функции и възможности

  • Поддръжка на спецификации Swagger 2.0 и OpenAPI 3.0 / 3.1 в JSON и YAML формат
  • Интерактивна странична лента с категоризирани крайни точки, HTTP методи и статус кодове
  • Дълбоко разрешаване на `$ref` схеми с показване на вложени модели на данни и ограничения за свойствата
  • 100% клиентски офлайн анализ (parsing), гарантиращ сигурността на поверителните корпоративни API договори

Как да използвате

  1. 1

    Поставете съдържанието на вашия `swagger.json` или `openapi.yaml`, или качете файла със спецификацията директно.

  2. 2

    Разгледайте структурираната API документация, визуализирана в интерактивния преглед.

  3. 3

    Разгънете произволна крайна точка, за да инспектирате заглавките на заявката, схемите на данните и примерните отговори.

Чести сценарии на употреба

  • → Одит на бекенд API дефиниции без необходимост от конфигуриране на отделен Swagger UI сървър
  • → Бърза проверка на ръчно написани OpenAPI спецификации за невалидни `$ref` референции
  • → Предоставяне на точни референции за схеми на фронтенд разработчиците по време на API интеграции

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

Често задавани въпроси и поверителност

Може ли този инструмент да чете директно YAML спецификации?

Да. Вграденият YAML парсер обработва както `.yaml`, така и `.json` OpenAPI спецификации изцяло в браузъра.

Качва ли се моята поверителна API спецификация на външни сървъри?

Не. Цялостният анализ на документа и рендерирането на схемите се изпълняват изключително в локалната памет на вашия браузър.