Scramble to pakiet dla Laravel, który generuje dokumentację API bez konieczności ręcznego pisania adnotacji PHPDoc. Interfejs użytkownika wykorzystuje elementy Spotlight do dostarczania interaktywnych dokumentów API z osadzonymi komponentami React lub Web Components, obsługiwanymi przez OpenAPI i Markdown.
Głównym mottem [Scramble] jest automatyczne generowanie jak największej ilości dokumentacji API. Pozwala to skupić się na kodzie i uniknąć adnotacji do każdego możliwego parametru / pola, ponieważ może to spowodować nieaktualną dokumentację. Generując dokumenty automatycznie na podstawie kodu, Twój interfejs API będzie zawsze miał aktualną dokumentację, której możesz zaufać.
Po zainstalowaniu Scramble w projekcie Laravel API, otrzymasz dwie nowe ścieżki: /docs/api do przeglądania naszej dokumentacji API oraz /docs/api.json który jest dokumentem Open API w formacie JSON używanym do opisu Twojego API.
Scramble opiera się na analizie statycznej i konwencjach Laravel, aby wygenerować jak najwięcej dokumentacji, z możliwością uzupełnienia automatycznej dokumentacji adnotacjami. Częścią tego, co robi Scramble, jest sprawdzanie żądań formularzy lub wywołanie w validate() celu udokumentowania wymaganych parametrów.
Inne fajne funkcje obejmują:
- Konfigurowalne rozpoznawanie trasy przy użyciu
Scramble::routes()metody - Bramka autoryzacji dokumentacji
- Konfiguracja serwera
- Schemat zabezpieczeń dokumentów przy użyciu wspólnych konwencji, takich jak JWT, Basic, OAuth2 itp.
- Interfejs API rozszerzeń
- I nie tylko
Aby rozpocząć korzystanie z Scramble, zapoznaj się z dokumentacją Wprowadzenie, która obejmuje instalację, konfigurację i inne elementy. Możesz dowiedzieć się więcej o tym pakiecie, uzyskać pełne instrukcje instalacji i wyświetlić kod źródłowy w witrynie GitHub.You can learn more about this package, get full installation instructions, and view the source code on GitHub.
