目次
- API とプロジェクトの概要
- プロジェクトの作成と初期設定
- データベースのマイグレーション
- シーダによるコメントデータの登録
- モデルの生成
- リソースの生成
- GETメソッドを利用した個別コメント取得のAPI作成
- 日本語文字列の表示と日時の調整
- GETメソッドを利用したコメント一覧取得のAPI作成
- データのラップ
- POSTメソッドを利用したコメントの新規投稿APIの作成
- PUTメソッドを利用したコメント更新APIの作成
- DELETEメソッドを利用したコメント削除APIの作成
- シーダの拡張
- ページネーションの実装
- 個別コメントをコントローラで取得
- Postman の利用
- ユーザ情報を登録する
- Sanctum によるユーザ認証
- ログインとトークン
- コメントとユーザのリレーションシップ
- 新規投稿時にユーザIDを記録する
- コメントからユーザ名を表示するリレーションシップ
- ユーザからコメント一覧を取得するリレーションシップ
- 更新と削除の権限設定
- 発行済みトークンの取得
- トークンの有効期限
- レート制限
- 閲覧権限の緩和
Laravel で API を開発する
Postman の利用
Laravel 作成した API を利用する際にこれまでは curl コマンドを利用していました．Python Django で作成した API の場合は Web ブラウザからでもさまざまな操作ができました．しかし，Laravel にはそのような機能がどうやらなさそうです．そこで，Postman というソフトウェアをインストールして利用してみます．
Postman は API の利用をテストするための GUI ツールで，ユーザ登録とログインが必要ですが，基本機能は無料で利用できます．Windows 用だけでなく Intel Mac 用や Apple Silicon Mac 用のバイナリファイルも提供されています．Postman のダウンロードサイトから環境に合わせたインストーラをダウンロードしてインストールしてください．
インストールできたら，Postman を起動します．起動画面は次のようになります．
新しいタブを開いて，テキストボックスに「192.168.56.101:8000/api/comments/」と入力します．その後，右側にある「送信ボタン」を押下すると GET メソッドで送信できます．
すると API からのレスポンスが画面下側のボックスに表示されました．
JSON形式のデータをインデントして見やすく整形することも可能です．
個別コメントの情報を取得します．
メソッドを「POST」に変更します．
「パラメーター」に「キー」と「値」を指定します．その後「送信」ボタンを押下すると POST メソッドで送信できます．
送信が成功して，その結果が表示されました．
再び一覧を取得すると，先ほど登録したデータが先頭に表示されました．
以降のページでも引き続き curl コマンドを利用して API をテストしますが，この Postman を利用しても構いません．なお，Postman 以外にも例えば Insomnia というツールも存在します．