Laravel 5.6でSwaggerを使用する方法

次のチュートリアルコラムでは、laravel 5.6 で swagger を使用する方法を紹介します。困っている友人の役に立てば幸いです。

laravel 5.6 で swagger を使用する

##この記事を書いているとき、私の laravelバージョンは

5.6.28

インストール

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 namespace App\Http\Controllers;

use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
/**
 * @SWG\Swagger(
 *   basePath="/calculate-rates",
 *   @SWG\Info(
 *     title="项目名称 API",
 *     version="1.0.0"
 *   )
 * )
 */
class Controller extends BaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}

コマンドを実行します

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');
    }

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

php artisan l5-swagger:generate

http://localhost/api/documentation に戻って更新すると、ドキュメントが表示されます。外観

# 推奨: 最新の 5 つの Laravel ビデオ チュートリアル

#

以上がLaravel 5.6でSwaggerを使用する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。