Comment utiliser Swagger dans Laravel 5.6-Laravel-php.cn

Comment utiliser Swagger dans Laravel 5.6

藏色散人

Libérer： 2021-03-04 09:04:58

avant

2632 Les gens l'ont consulté

Lors de la rédaction de cet article, mon la version de Laravel est 5.6.28

Installer

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)
...

Copier après la connexion

Exécuter

php artisan vendor:publish

Copier après la connexion

Sélectionner L5SwaggerL5SwaggerServiceProvidercet élément
À ce moment, deux fichiers

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

Configuration

Ajoutez un commentaire avant

dans le fichier 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;
}

Copier après la connexion

Exécutez la commande

php artisan l5-swagger:generate

Copier après la connexion

Ouvrez l'URL de votre projet

, vous verrez que swagger a été exécuté avec succès, mais il n'est affiché aucune documentation API. http://localhost/api/documentation

Écrire la documentation

Prendre

Exemple : http://localhost/homeÉcrire la documentation sur la méthode
de 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');
    }

Copier après la connexion

Exécuter à nouveau la commande