Scalar

Scalar — это платформа для создания профессиональной и удобной документации API. Вы предоставляете свой документ OpenAPI, а Scalar преобразует его в легко читаемые страницы с примерами и встроенными инструментами для тестирования.

Платформа предлагает несколько продуктов, работающих вместе. API Reference отображает вашу документацию в чистом и понятном формате. API Client позволяет разработчикам напрямую тестировать конечные точки. Платформа также включает инструменты для управления несколькими версиями ваших API-документов и синхронизации с GitHub.

Scalar полностью с открытым исходным кодом, что означает, что код доступен публично и бесплатен для использования. Вы можете разместить его самостоятельно или воспользоваться их облачным сервисом. Бесплатный тариф покрывает базовые функции, а платные планы добавляют инструменты для совместной работы, собственные домены и улучшенную поддержку.

Использовать Scalar просто и не требует сложной настройки. Вот шаги для начала работы:

• Посетите сайт Scalar и создайте бесплатный аккаунт, чтобы сохранять свою работу. Вы получите бесплатный поддомен, например yourname.apidocumentation.com.

• Загрузите ваш документ OpenAPI, вставив URL, загрузив файл или подключившись к GitHub. Scalar поддерживает форматы JSON и YAML.

• Выберите тему и настройте цвета в соответствии с вашим брендом. Вы можете добавить пользовательский CSS, если хотите получить больший контроль над дизайном.

• Напишите дополнительные руководства с помощью редактора. Эти страницы объясняют концепции, выходящие за рамки автоматических справочных страниц.

• Тестируйте ваши API-эндпоинты с помощью встроенного клиента. Нажмите на любой эндпоинт, добавьте параметры и отправьте запросы, чтобы увидеть реальные ответы.

• Делитесь вашей документацией с командой или сделайте её публичной. Вы можете настроить разрешения, чтобы контролировать, кто может редактировать или просматривать.

• Красивое API-документирование из файлов OpenAPI

• Встроенное тестирование с API-клиентом

• Интеграция с GitHub и автоматическая синхронизация

• Пользовательские домены и темы

• Интеграция с фреймворками для всех основных платформ

• Поиск на базе TypeSense

• Поддержка нескольких версий API

• Руководства в формате Markdown и MDX

• Инструменты для командного сотрудничества

• Открытый исходный код и возможность самостоятельного хостинга

• Включён бесплатный поддомен

• Поддержка пользовательских CSS и JavaScript