Laravel 5.6でSwaggerを使用する方法-Laravel-php.cn

インストール

composer require darkaonline/l5-swagger Using version ^5.6 for darkaonline/l5-swagger ... - Installing swagger-api/swagger-ui (v3.17.4) - Installing doctrine/annotations (v1.6.0) - Installing zircote/swagger-php (2.0.13) - Installing darkaonline/l5-swagger (5.6.5) ...

ログイン後にコピー

実行

php artisan vendor:publish

ログイン後にコピー

選択

L5Swagger\L5SwaggerServiceProvider

This

2 つのファイルが表示されます。現時点で追加されます

/config/l5-swagger.php
/resources/views/vendor/l5-swagger/index.blade.php

Configuration
app/Http/Controllers/Controller.php

ファイルの

class

の前にコメントを追加します。


         
          ログイン後にコピー

コマンドを実行します

php artisan l5-swagger:generate

ログイン後にコピー

プロジェクト URLhttp://localhost/api/documentation を開くと、Swagger が正常に実行されたことがわかりますが、API ドキュメントは表示されません。

ドキュメントを書く

Gethttp://localhost/home

例:

HomeController

の

indexメソッド上記のドキュメント

/** * @SWG\Get( * path="/home", * summary="用户资料", * @SWG\Response(response=200, description="请求成功"), * @SWG\Response(response=401, description="用户验证失败"), * @SWG\Response(response=500, description="服务器错误") * ) * */ public function index() { return view('home'); }

ログイン後にコピー

を参照し、もう一度コマンドを実行します。