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

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

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

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

命名規則

命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

API

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

Q&A

0回答

1072閲覧

リソースのステータスを変更するAPIの命名

uS_aito

総合スコア145

REST

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

命名規則

命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

API

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

0グッド

0クリップ

投稿2020/07/09 07:34

現在、VM等のリソースを操作するAPIの開発を行なっています。
VMの電源をOn/OFF/RestartするAPIとして、以下のようなURLを設計しました。

  • /vm/{vm_name}/start
  • /vm/{vm_name}/stop
  • /vm/{vm_name}/restart

しかし、APIの命名規則について調べたところ、様々なサイトでAPIには動詞を含めてはいけない、APIの意図が不明確になるといった記述に出会いました。

これらのページの言うことも最もで、例えば/startにGETするってなんだ?と言う自分の疑問にも符合するものでした。
一方で、では今回のケースでは正しい命名は何か?がわかりません。やっていることはVMのステータスの更新ですので、以下のようなURLに、以下のようなbodyをPUTするのが正しいのでは?と思いましたが、果たして客観的に見て、リソースに対する処理の意図が明確であるか確証が持てません。

  • /vm/{vm_name}/status
{ "status": "UP" }

リソースのステータスを更新するようなAPIでは、どのような命名をするべきでしょうか。上記のような例で良いのか、あるいはより良い例がある場合はご教授いただけると幸いです。

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

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

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

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

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

guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだ回答がついていません

会員登録して回答してみよう

アカウントをお持ちの方は

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

ただいまの回答率
85.49%

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

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

質問する

関連した質問