За Преглед на OpenAPI / Swagger документация — Подробно ръководство
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 отговори и схеми на данните.
Основни функции и възможности
- Поддръжка на спецификации Swagger 2.0 и OpenAPI 3.0 / 3.1 в JSON и YAML формат
- Интерактивна странична лента с категоризирани крайни точки, HTTP методи и статус кодове
- Дълбоко разрешаване на `$ref` схеми с показване на вложени модели на данни и ограничения за свойствата
- 100% клиентски офлайн анализ (parsing), гарантиращ сигурността на поверителните корпоративни API договори
Как да използвате
- 1
Поставете съдържанието на вашия `swagger.json` или `openapi.yaml`, или качете файла със спецификацията директно.
- 2
Разгледайте структурираната API документация, визуализирана в интерактивния преглед.
- 3
Разгънете произволна крайна точка, за да инспектирате заглавките на заявката, схемите на данните и примерните отговори.
Чести сценарии на употреба
- → Одит на бекенд API дефиниции без необходимост от конфигуриране на отделен Swagger UI сървър
- → Бърза проверка на ръчно написани OpenAPI спецификации за невалидни `$ref` референции
- → Предоставяне на точни референции за схеми на фронтенд разработчиците по време на API интеграции
Свързани инструменти
Генератор на HTML мета тагове (SEO)
Генериране на пълни мета тагове за SEO, Open Graph и Twitter Cards.
.gitignore Генератор
Създаване на подходящи .gitignore файлове за Node.js, Python, Java, Go, Rust и десетки други среди.
Генератор на софтуерни лицензи
Генериране на стандартни Open Source лицензи (MIT, Apache 2.0, GPL, BSD) с вашите данни.
Генератор на README файлове
Интерактивно структуриране и генериране на професионален README.md файл за проекти.
Conventional Commits Помощник
Стандартизирано съставяне на съобщения за Git commit според конвенцията Conventional Commits.
Калкулатор за семантично версиониране (SemVer)
Валидация, сравнение и изчисляване на следваща версия съгласно Semantic Versioning.
Често задавани въпроси и поверителност
Може ли този инструмент да чете директно YAML спецификации?
Да. Вграденият YAML парсер обработва както `.yaml`, така и `.json` OpenAPI спецификации изцяло в браузъра.
Качва ли се моята поверителна API спецификация на външни сървъри?
Не. Цялостният анализ на документа и рендерирането на схемите се изпълняват изключително в локалната памет на вашия браузър.