質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.35%
HTTP

HTTP(Hypertext Transfer Protocol)とはweb上でHTML等のコンテンツを交換するために使われるアプリケーション層の通信プロトコルです。

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

Q&A

解決済

1回答

1883閲覧

WebAPIのURI設計について

maskmelon

総合スコア63

HTTP

HTTP(Hypertext Transfer Protocol)とはweb上でHTML等のコンテンツを交換するために使われるアプリケーション層の通信プロトコルです。

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

0グッド

2クリップ

投稿2020/08/28 11:35

編集2020/08/28 11:47

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

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

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

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

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

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

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

ベストアンサー

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

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

投稿2020/08/28 16:43

YakumoSaki

総合スコア2027

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

maskmelon

2020/08/30 07:05

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.35%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問