第7回 社内勉強会 「REST APIを作ってみよう」

Transcript

1. REST APIを作ってみよう
 第7回 社内勉強会
 2022/12/24

2. 準備

3. Docker環境を構築し、
 dockerとdocker-composeコマンドを使用できるようにする
 
 Windows編
 https://media.wemotion.co.jp/technology/docker-windows/
 Mac編
 https://media.wemotion.co.jp/technology/docker-mac/
 Docker環境構築

4. PostmanはGUI上からHTTPリクエストを自由度高く発行することができる
 
 PostmanをChrome Extensionsからインストール
 https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=ja 
 Postmanインストール
 ※ 初回実行時にGoogleアカウンなどで無料登録（簡単な質問回答）とSign Inが必要

5. PHPの代表的なフレームワーク
 MVCモデルを採用している
 
 M: Model
 V: View
 C: Controller
 LaravelでREST APIを開発
 出典: https://laravel.com/ 

6. gitコマンドが使用可能な場合は git clone
 gitコマンドを使用しない場合は「Download ZIP」して解凍
 
 https://github.com/wemotion-inc/docker-laravel-api
 第7回 勉強会用 リポジトリ

7. ソースコードの準備
 git clone
 
 or
 
 Download ZIP
 
 にてソースコードを取得

8. ダウンロードしたディレクトリに入り、コンテナの初回起動を行う 
 
 PHP環境、DB(MySQL)環境、Webサーバー(Nginx)環境を、 
 一発でコンテナ上に構築できるよう設定済み
 
 コンテナ準備
 # docker-composeでコンテナ起動（初回は必要なリソースをインストール） docker-compose up -d --build
9. REST API

10. REST APIのRESTとは、「Representational State Transfer」の略
 
 代表的な特徴
 - 統一されたインターフェイス
 - ステートレス
 - 階層型システム
 - キャッシュ可能性
 - オンデマンドのコード
 REST APIとは
 出典: https://aws.amazon.com/jp/what-is/restful-api/ 

11. URIによってリクエストを行うリソースを特定し、
 HTTPメソッドを使用することでサーバーサイド（DB）に対して
 - データ取得
 - データ登録
 - データ更新
 - データ削除
 などをHTTPリクエストすることができる
 一般的にJSON形式でデータのやりとりを行う
 REST API概要

12. HTTPメソッドと用途
 メソッド
 用途
 GET
 指定されたURLにあるリソースを 参照する（Read）
 リクエスト パラメータでフィルター処理をサーバーに指示可能 
 POST
 サーバーにデータを送信し 作成する（Create)
 PUT
 サーバー上の既存のリソースを 更新する（Update)
 DELETE
 サーバー上のリソースを 削除する（Delete）

13. REST API I/F設計

14. 要件
 本の情報登録、本の一覧取得、本の情報更新、本の削除が可能なAPI
 
 仕様
 - 登録情報
 - タイトル、著者、出版年
 - 絞り込みで一覧取得
 - 出版年で絞り込み
 “本”についてCRUDするREST API

15. URI設計
 URI
 メソッド
 概要
 /api/books
 GET
 本の一覧を取得
 クエリパラメータ 出版年(published_yaer) で絞り込み 
 /api/books
 POST
 本の情報を登録
 /api/books/{book_id} 
 GET
 book_idにマッチする本の情報を 取得
 /api/books/{book_id} 
 PUT
 book_idにマッチする本の情報を 更新
 /api/books/{book_id} 
 DELETE
 book_idにマッチする本を 削除

16. ハンズオン

17. Docker コンテナ上のPHP環境にLaravelをインストールする
 Laravelインストール
 # PHP環境(app)のコンテナに入る docker-compose exec app bash # Laravelをインストール composer create-project --prefer-dist "laravel/laravel=8.*" . # コンテナからの抜け方 exit
18. /src/.env ファイルの DB_CONNECTION の部分を以下に差し替え 
 
 
 
 
 
 ※ 11~16行目あたり 
 DB接続の設定ファイル作成
 DB_CONNECTION=mysql DB_HOST=db DB_PORT=3306 DB_DATABASE=database DB_USERNAME=root DB_PASSWORD=password
19. Laravelのアプリケーションで利用したいテーブルの作成などを行う
 
 
 
 
 
 ※ 直接SQLを書かなくてもPHPの記述からテーブル作成を行うことができる 
 マイグレーション
 # PHP環境(app)のコンテナに入る（既に入ってる場合は Migrateへ） docker-compose exec app bash # Migrateを行う php artisan migrate
20. マイグレーションで作成されたテーブル一覧を見てみる
 テーブルの確認
 # DB環境(MySQL)のコンテナに入る docker-compose exec db bash # MySQLに入る mysql -u root --password=password # データベース領域指定 use database; # テーブル一覧表示 show tables;
21. Bookモデルクラス作成
 # PHP環境(app)のコンテナ内で実行 php artisan make:model Book --migration
22. src/app/Models/Book.php
 <?php namespace App\Models; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; class Book extends Model { use HasFactory; protected $fillable = [ 'title', 'author', 'published_year' ]; }
23. src/database/migrations/xxxx_create_books_table.php
 public function up() { Schema::create('books', function (Blueprint $table) { $table->id(); $table->string('title'); $table->string('author'); $table->integer('published_year'); $table->timestamps(); }); } /** * Reverse the migrations. * * @return void */ public function down()
24. migrate & Bookコントローラー作成
 # PHP環境(app)のコンテナ内で実行 php artisan migrate # コントローラー作成 php artisan make:controller BookController --api
25. routes/api.php
 <?php use Illuminate\Http\Request; use Illuminate\Support\Facades\Route; use App\Http\Controllers\BookController; Route::middleware('auth:sanctum')->get('/user', function (Request $request) { return $request->user(); }); Route::apiResource('/books', BookController::class);
26. ルーティング確認
 # PHP環境(app)のコンテナ内で実行 php artisan route:list
27. コントローラー メソッド追加(POST)
 app/Http/Controllers/BookController.php
 <?php namespace App\Http\Controllers; use Illuminate\Http\Request; use App\Models\Book; class BookController extends Controller { /** * Store a newly created resource in storage. * * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\Response */ public function store(Request $request) { $book = Book::create($request->all()); return response()->json( $book, 201 ); }
28. コントローラー メソッド追加(GET)
 <?php namespace App\Http\Controllers; use Illuminate\Http\Request; use App\Models\Book; class BookController extends Controller { /** * Display a listing of the resource. * * @return \Illuminate\Http\Response */ public function index() { $books = Book::all(); return response()->json( $books, 200 ); }
29. PostmanからPOST(データ登録)してみる
 「POST」を選択
 URL: http://localhost:8081/api/books
 Bodyに「JSON (application/json)」形式で
 title, author, published_yearを設定
 
 Sendを実行して
 Statusが201 Createdなら登録成功！

30. PostmanからGET(データ取得)してみる
 「GET」を選択
 URL: http://localhost:8081/api/books
 
 Sendを実行して
 Statusが200 OKで
 登録したJSONが返って来れば成功！

31. コントローラー メソッド追加(GET 1件)
 /** * Display the specified resource. * * @param int $id * @return \Illuminate\Http\Response */ public function show($id) { $book = Book::where('id', $id)->get(); if ($book) { return response()->json( $book, 200 ); } else { return response()->json( [ 'message' => "Book $id not found" ], 404 ); } }
32. PostmanからGET(book_idで取得)してみる
 「GET」を選択
 book_id=4を取得したい場合
 URL: http://localhost:8081/api/books/4
 
 Sendを実行して
 Statusが200 OKで指定のbook_idを持つ
 JSONが返って来れば成功！

33. コントローラー メソッド追加(UPDATE)
 /** * Update the specified resource in storage. * * @param \Illuminate\Http\Request $request * @param int $id * @return \Illuminate\Http\Response */ public function update(Request $request, $id) { $update = [ 'title' => $request->title, 'author' => $request->author, 'published_year' => $request->published_year ]; $book = Book::where('id', $id)->update($update); if ($book) { return response()->json( $book, 201 ); } else { return response()->json([ 'message' => 'Book not found', ], 404); } }
34. PostmanからUPDATE(データ更新)してみる
 「PUT」を選択
 book_id=4をデータ更新したい場合
 URL: http://localhost:8081/api/books/4
 Bodyに「JSON (application/json)」形式で
 更新後のtitle, author, published_yearを設定
 
 
 Sendを実行して
 Statusが201 Createdで更新成功！

35. コントローラー メソッド追加(DELETE)
 /** * Remove the specified resource from storage. * * @param int $id * @return \Illuminate\Http\Response */ public function destroy($id) { $book = Book::where('id', $id)->delete(); if ($book) { return response()->json([ 'message' => 'Book deleted successfully', ], 202); } else { return response()->json([ 'message' => 'Book not found', ], 404); } }
36. PostmanからDELETE(データ削除)してみる
 「DELETE」を選択
 book_id=5をデータ更新したい場合
 URL: http://localhost:8081/api/books/5
 
 Sendを実行して
 Statusが202 Acceptedで削除成功！

37. コントローラー メソッド追加(GET 絞り込み)
 /** * Display a listing of the resource. * * @return \Illuminate\Http\Response */ public function index(Request $request) { $published_year = $request->query('published_year'); if ($published_year) { $books = Book::where('published_year', $published_year)->get(); } else { $books = Book::all(); } return response()->json( $books, 200 ); }
38. PostmanからGET(絞り込み）してみる
 「GET」を選択
 published_year=2022のデータを取得したい場合
 
 URL: http://localhost:8081/api/books?published_year=2022 
 
 Sendを実行して
 Statusが200 OKで成功！

39. app\Http\Controllers\BookController.php
 https://github.com/wemotion-inc/docker-laravel-api/wiki/app%5CHttp%5CControllers%5 CBookController.php