見出し画像

【Web API】APIのURL(エンドポイント)の命名

モデル型かアクション型か
URLを設計する際にRESTfulに作るのがデファクトになっていいるが、その中でもURLの作り方をモデル(ユーザ、商品など)にするか、アクション型(購入する、出席するなど)にするかで分かれる。どちらを採用するにしても明確な基準が必要である。両方を満遍なく取り入れると、非常に分かりづらいものになってしまう。

一般的にはモデル型

一般的には GET /users/1 でユーザデータに対する操作であるといった形にする。つまりモデル型である。 となると POST /purchase で購入するというアクションを定義するよりも POST /orders で注文データを作成するといった形の方が自然です。

またログインにおいてもセッションデータを作成するという意味で POST /session のが良い。セッションはブラウザごとに一つなので複数形ではなく単数形となる。 POST /login といったアクションベースではない方が良い。

引用:綺麗なAPIを設計するには気をつけたい5つのポイント

この記事が気に入ったらサポートをしてみませんか?