close

Laravel APIドキュメントを 自動生成 Swagger

Swagger API ドキュメントを自動的に生成する ようなツールを使用すると、 Laravel API のドキュメントを作成および管理する便利な方法です。 Swagger は、API の説明、文書化、テストに役立つオープンソース ツールです。 Swagger in を 使用して API ドキュメントを生成する方法は次のとおりです Laravel。

ステップ 1: インストール Swagger する Laravel

Composer を使用して をインストールし Swagger package ます Laravel。 package この目的で よく使われるのは です darkaonline/l5-swagger。 

composer require "darkaonline/l5-swagger:~9.0"

ステップ 2: 設定する Swagger

インストール後、アプリケーションのディレクトリ Swagger にドキュメント を公開する必要があります 。 これを行うには、次のコマンドを実行します 。 public Laravel Artisan 

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

次に、ドキュメントを公開する場所の指定を含め、 構成ファイルを編集してアプリケーション用に config/l5-swagger.php 構成する必要があります。 Swagger

ステップ 3: 使用する Annotations

annotations アプリケーション内のルートのドキュメントを記述するために 使用します Laravel。 これらは、 API ドキュメントを自動的に生成するため annotations に使用されます。 Swagger 例えば： 

/**  
 * @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()  
 *      )  
 *)  
 */

Bước 4: Truy cập Tài liệu API Swagger

Khi bạn đã cấu hình và đặt các chú thích tương ứng, bạn có thể truy cập tài liệu API Swagger bằng cách truy cập URL tương ứng với đ ịa chỉ mà bạn đã cấu hình trong tệp cấu hình. Thông thường、URL nay sẽ có định dạng http://your-app-url/api/documentation。

Swagger あなたのルートを確認してください。

Swagger APIを 使用すると Laravel 、非常に便利な API が提供されます。