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