同一リソースについてビューとJSONを返す場合のURI設計

Question

例えば、/users/selfというURIでユーザーのプロフィール画面のビューを返している場合に、ユーザー情報をJSON形式で返すAPIを作りたいとすると、どのようなURIにするのが一般的でしょうか？ここでのAPIは公開用ではなく、アプリケーション内部でリソースにアクセスするために設置するものです。

APIのURI設計についてはUIとは別立てで論じられていることが多く、このような場合にどういったURIが自然なのか分からず質問させていただきました。

現状/users/self/jsonのようにしているのですが、これで問題ないでしょうか？

Answer 1

現状/users/self/jsonのようにしているのですが、これで問題ないでしょうか？

そのような設計のアプリケーション、と決めるなら、それで問題ないと思います。

が、REST が前提だと、パスはあくまでリソースを表すべきで、 json のような種別は別の部分に入れる気がします。

1. extension を利用する /users/self / /users/self.html / /users/self.json / ...
2. パラメーターを利用する /users/self?ext=html / /users/self?ext=json / ...
3. ヘッダを利用する Accept: text/html / Accept: application/json / ...

個人的には 1のケースが多いような気はしますが、どれを利用するかは完全に自由だと思います。

追記

ここでのAPIは公開用ではなく、アプリケーション内部でリソースにアクセスするために設置するものです。

もしくは、根本から分けることもできました

1. パス http://example.com/users/self / http://example.com/api/users/self
2. ドメイン http://web.example.com/users/self / http://api.example.com/users/self

Comments

[maskmelon]

丁寧な回答をありがとうございます。jsonをパスに入れないほうが良い理由も納得できました。