@powerduck/oas-document
Готовый к использованию в продакшене компонент документации OpenAPI для React. Передайте документ OAS и получите полноценный интерфейс API-документации в стиле Stripe: навигацию в шапке, светлую и тёмную темы, дерево навигации, отслеживание прокрутки, просмотр схем и примеры кода на нескольких языках.
- Имя пакета:
@powerduck/oas-document - Версия:
- Лицензия: MIT
Используемые библиотеки: @powerduck/openapi-parser (проверка и автоматическое преобразование), @powerduck/tree (навигация), @powerduck/md-editor (отрисовка Markdown), @powerduck/openapi-codegen (генерация кода запросов).
Возможности
- Готовая API-документация — Принимает разобранный объект, строку JSON или строку YAML
- Макет в стиле Stripe — Настраиваемая шапка, дерево в боковой панели и двухколоночное представление операций
- Светлая и тёмная темы — Переключение в шапке, выбор сохраняется в localStorage
- Автоматическое преобразование в OAS 3.2 — Проверка и преобразование через
@powerduck/openapi-parser - Навигация с отслеживанием прокрутки — Пассивный обработчик прокрутки с двоичным поиском
- отрисовка Markdown — Описания отображаются через
@powerduck/md-editor - Примеры кода на нескольких языках — Генерируются через
@powerduck/openapi-codegen - Просмотр схем — Таблицы вложенных свойств с раскрытием и сворачиванием
- Адаптивный интерфейс — На мобильных устройствах боковая панель открывается поверх содержимого