WebAPIのURI設計について

Question

WebAPIのURI設計について勉強しています。

リソースを示すURIのエンドポイントには名詞を使うべきであること、リソースをどのように扱うかという動詞に対応する部分はHTTPの各メソッドに任せるべきであることを知りました。

この原則からすると、ユーザーを新規作成する場合/usersというエンドポイントに対してPOST処理をする設計になると思うのですが、ユーザーの新規作成画面をレンダリングする必要がある場合にURIをどう設計すればよいのか悩んでいます。

現状、GET /users/createで新規作成画面を表示し、POST /users/createで新規作成処理を行うという設計にしているのですが、これはあまり良くないのでしょうか？

HTMLページのレンダリングはAPIではないのでcreateという動詞を使っても問題ないけれど、リソースを操作する場合には原則に乗っ取ってPOST /usersとするべきなのかなと考えているのですがどうでしょうか？

明確に答えがあるものではないとは思いますが、一般的な手法を知りたく質問させていただきました。
よろしくお願いします。

Answer 1

質問者さんの考えで良いと思います。
APIと普通のWebUIとではURLの設計が変わるというのも違和感はありません。

一応質問の中に書いてなかったので念の為ですが、API系は /api/v1/対象（名詞）/（キー） のように /api で始まるようにしておくのがよいかと思います。
でないと、Webページが帰ってくるのかJSON等が帰ってくるのか区別がつきにくくなりますので…

Comments

[maskmelon]

回答くださりありがとうございます。
WebUIとAPIの区別についても参考になりました。