laravel-openapiライブラリ パスパラメーターの値にdescriptionを入れる

概要

• laravel-openapiにてパスパラメーターの値にdescriptionを設定する方法をメモ的にまとめる。

方法

1. 下記のようなルーティングとコントローラーの記載があったとする。

   1. ルーティング

      web.php

      Route::get('/Hoge/{hogeType}/{hogeId}', [HogeController::class, 'get']);
      

   2. コントローラー

      HogeController.php

      use Vyuldashev\LaravelOpenApi\Attributes as OpenApi;
      
      #[OpenApi\PathItem]
      class HogeController extends Controller
      {
          #[OpenApi\Operation()]
          public function get(string $hogeType, string $hogeId): void
          {
          }
      }
      

2. 下記のようにコントローラーの関数にパラメーターをPHPDocで記載する。

   HogeController.php

   use Vyuldashev\LaravelOpenApi\Attributes as OpenApi;
   
   #[OpenApi\PathItem]
   class HogeController extends Controller
   {
       /**
        * @param string $hogeType hogeのtype
        * @param string $hogeId hogeのid
        * @return void
        */
       #[OpenApi\Operation()]
       public function get(string $hogeType, string $hogeId): void
       {
       }
   }
   

3. 出力すると下記のようにSwaggerで表示される。