Die Verwendung von Tools wie Swagger der automatischen Generierung von API-Dokumentation Laravel ist eine bequeme Möglichkeit, Dokumentation für Ihre API zu erstellen und zu verwalten. Swagger ist ein Open-Source-Tool, das Ihnen hilft, Ihre APIs zu beschreiben, zu dokumentieren und zu testen. So können Sie Swagger in Laravel zum Generieren einer API-Dokumentation verwenden:
Schritt 1: Installieren Swagger für Laravel
Verwenden Sie Composer, um Swagger package for zu installieren Laravel. Ein beliebtes Mittel package für diesen Zweck ist darkaonline/l5-swagger.
composer require "darkaonline/l5-swagger:~9.0"
Schritt 2: Konfigurieren Swagger
Nach der Installation müssen Sie die Swagger Dokumentation im public Verzeichnis Ihrer Laravel Anwendung veröffentlichen. Sie können dies tun, indem Sie folgende Artisan Befehle ausführen:
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
Anschließend müssen Sie die Konfigurationsdatei bearbeiten, config/l5-swagger.php um sie für Ihre Anwendung zu konfigurieren Swagger, einschließlich der Angabe des Speicherorts, an dem die Dokumentation veröffentlicht wird.
Schritt 3: Verwenden Annotations
Verwenden Sie diese Option annotations, um die Dokumentation Ihrer Routen in Ihrer Laravel Anwendung zu beschreiben. Diese annotations werden verwendet, um Swagger die API-Dokumentation automatisch zu generieren. Zum Beispiel:
/**
* @OA\Get(
* path="/api/users",
* operationId="getUsersList",
* tags={"Users"},
* summary="Get list of users",
* description="Returns list of users",
* @OA\Response(
* response=200,
* description="Successful operation",
* @OA\JsonContent()
* )
*)
*/
Schritt 4: Echte API-Unterstützung Swagger
Hier finden Sie die Möglichkeit, eine echte Cập-Liệu-API zu verwenden, um eine echte Cập- Swagger URL zu finden Es ist wichtig, dass Sie es nicht verpassen. Bitte beachten Sie, dass die URL nicht verfügbar ist http://your-app-url/api/documentation.
Swagger Sobald Sie die Route verlassen haben, können Sie sich auf den Weg machen, den Sie brauchen, um sich zurechtzufinden.
Sie benötigen Swagger eine Laravel API-Anleitung, um eine neue Version zu erstellen.