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