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), параметре заглавља, параметре упита, структурирана тела захтева, HTTP статусне кодове одговора и шеме података.

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

Кључне функције и могућности

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

Како се користи

  1. 1

    Налепите текст датотеке `swagger.json` или `openapi.yaml`, или директно отпремите датотеку спецификације.

  2. 2

    Прегледајте структурирану API документацију приказану у интерактивном прегледачу.

  3. 3

    Проширите било коју крајњу тачку да бисте прегледали заглавља захтева, шеме тела захтева и примере одговора.

Уобичајени случајеви употребе

  • → Ревизија дефиниција бекенд API-ја без подизања посебног Swagger UI сервера
  • → Провера исправности ручно писаних OpenAPI спецификација ради проналажења неважећих `$ref` показивача
  • → Пружање тачних референци шема фронтенд инжењерима током интеграције API-ја

Сродни алати

Честа питања и приватност

Може ли овај алат директно да чита YAML спецификације?

Да. Уграђени YAML парсер обрађује и `.yaml` и `.json` спецификације OpenAPI уговора у потпуности унутар прегледача.

Да ли се моја власничка API спецификација шаље на спољне сервере?

Не. Сво парсирање докумената и рендеровање шема извршава се искључиво у локалној меморији вашег прегледача.