LaravelとScribeでAPI仕様書を自動生成する

Laravel

LaravelのAPI情報をScribeで上の画像のような仕様書を自動作成できるらしいのでやってみました。

環境

Laravel 10
Composer

インストール

まずはターミナルで以下のコマンドを実行
実行はプロジェクトのルートディレクトリ(laravelのプロジェクトディレクトリ)で行いまいした。

composer require --dev knuckleswtf/scribe

php artisanコマンドでインスト

php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --tag=scribe-config

config/scribe.phpが生成されているのでその中の以下の部分をlaravelに書き換えます

// 元のコード
'type' => 'static',

//　修正後
'type' => 'laravel',

ModelやAPIがすでにある場合は以下のコマンドでドキュメントがpublic/docs内に生成されます。
APIの変更をするたびに以下のコマンドを実行すると修正されます。

php artisan scribe:generate

以下のURLにアクセスするとドキュメントが閲覧できます。
http://127.0.0.1:8000/docs

運用するとき

このまま公開すると皆に見られるので、私はgit管理するときはpublic/doc/はignoreで管理対象外にしています。
公開ドキュメントにするなら特に気にする必要はないです。

コメント