新卒研修で実施したアプリ開発におけるサーバー構造とAPIについて振り返りました！

sudo systemctl enable apache2

実装

・Laravelのプロジェクトを作成した時、デフォルトでAPI用のRouter、Controllerとwebページ用の物を分けてました。

Routerのパスは/route/api.php、Controllerのパスは/app/Http/Controllers/APIです。注意したいのは、RouteServiceProviderがデフォルトでRouterファイルをmiddleware "api" groupに追加したので、テストやアクセスする時URLの前で /api/を付けないといけないです。

例えば、

Route::get('stores','API\StoreController@index'); // -> api/stores
Route::get('stores/{store_id}','API\StoreController@getFloor'); // -> api/stores/{stores_id}
Route::get('stores/{store_id}/product','API\StoreController@searchProduct'); // -> /api/stores/{store_id}/product?keyword={keyword}

・Routerの部分が設定が完了したので、続いてControllerの部分を進めたいと思います。

まず、StoreControllerを作ります。

$ php artisan make:controller API/StoreController

StoreControllerの中身は以下の通りです。

class StoreController extends Controller
{
    public function index()
    {
        try {
            $header = array(
                'Content-Type' => 'application/json; charset=UTF-8',
                'charset' => 'utf-8'
            );

            $result = //SQL code...
              
            return response()->json([
                'stores' => $result
            ], 200, $header, JSON_UNESCAPED_UNICODE);
        } catch (\Throwable $e) {
            return response()->json([
                'error' => [
                    'code' => [$e->getCode()],
                    'messages' => [$e->getMessage()]
                ],
            ]);
        }
    }
}

• • $result　→　データベースを操作し、与えたデータです。
  • return response()->json()　→　
    • responseインスタンスを返せばレスポンスのステータスやヘッダーをカスタマイズができます。
    • jsonメソッドはresponseインスタンスを提供したHTTPレスポンスは構築するためのメソッドの一つです。
    • jsonメソッドが指定された配列をPHP関数json_encodeによりJSONへ変更します。
  • JSON_UNESCAPED_UNICODE　→　マルチバイト Unicode 文字をそのままの形式で扱います。デフォルトの場合であれば、漢字などが\uXXXXにエスケープします。

振り返ってみると簡単な気がしますが、この機会でまだ完全に理解出来でない部分を洗い出すことができ、いろいろ調べることで、改めて理解することが出来ました。

以上は「lead」のサーバーとAPIの説明となります。