Scramble - це пакет для Laravel, який генерує документацію API, не вимагаючи від вас написання анотацій PHPDoc вручну. Інтерфейс користувача використовує Spotlight Elements для надання інтерактивних документів API з вбудованими React або веб-компонентами на основі OpenAPI та Markdown.
Основним девізом [Scramble] є автоматичне створення якомога більшої кількості документації API. Це дозволяє зосередитися на коді та уникнути анотування всіх можливих параметрів/полів, оскільки це може призвести до застарілої документації. Автоматично генеруючи документи з коду, ваш API завжди матиме актуальну документацію, якій можна довіряти.
Після встановлення Scramble у вашому проекті API Laravel, ви отримаєте два нових маршрути: /docs/api для перегляду нашої документації по API і який є відкритим документом API у форматі /docs/api.json JSON, який використовується для опису вашого API.
Scramble покладається на статичний аналіз та конвенції Laravel, щоб створити якомога більше документації для вас, з можливістю доповнити автоматичну документацію анотаціями. Частина того, що робить Scramble, - це запити на перевірку форми або виклик validate() для документування необхідних параметрів.
Інші акуратні функції включають:
- Налаштування дозволу маршруту за допомогою методу
Scramble::routes() - Ворота авторизації документації
- Конфігурація сервера
- Схема захисту документів з використанням загальних конвенцій, таких як JWT, Basic, OAuth2 тощо.
- API розширень
- І багато іншого
Щоб розпочати роботу зі Scramble, перегляньте документацію до початку роботи, яка містить інсталяцію, настроювання тощо. Ви можете дізнатися більше про цей пакет, отримати повні інструкції зі встановлення та переглянути вихідний код на GitHub.
