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

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

ただいまの
回答率

90.35%

  • Ruby on Rails

    7666questions

    Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

  • Webサーバー

    458questions

    Webサーバーとは、HTTPリクエストに応じて、クライアントに情報を提供するシステムです。

  • Express

    259questions

    ExpressはNode.jsのWebアプリケーションフレームワークです。 マルチページを構築するための機能セットおよびハイブリッドのWebアプリケーションを提供します。

サーバのAPI設計について

受付中

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 550

metameta

score 2

 サーバのAPI設定についての質問です

REST APIというものを知り、とてもわかりやすくて良いなと思いました。
僕の理解は、以下の様です。

  • データベース等からデータを検索する際にGETをつかう。
  • データベース等にデータを登録する際にPOSTをつかう。
  • データベース等からデータを削除する際にDELETEつかう。
  • データベース等のデータを更新する際にPUTをつかう。
  • それぞれに対して、複数形の名詞を使う
  • idを指定する場合はhoges/:idとする

ここで質問なんですが、

  • データベース等にアクセスせず、クライアントからのデータをサーバ側で加工し、
    再度クライアント側へ返信するようなAPIの場合はどれを使うのが自然なんでしょうか。
  • また、その際にapiの名前はどうするべきなのでしょうか。

例えば、凄く簡単な例だと、

  • webページ(クライアント)に自然数を入力し、サーバ側に送信
  • サーバ側は受け取った数をインクリメントする処理を実行する
  • 結果をクライアントへ返信する

という例があったとして

この場合は{GET/POST/DELETE/PUT}のどれを使えば良いのでしょうか。
また、apiのエンドポイントはどのような名前にするべきでしょうか

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

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

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

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

+1

HTTPリクエストを理論的に考えていく上では、冪等かどうか、ということがポイントとなってきます。

  • 冪等なリクエスト(=何回リクエストしても同じ結果となるリクエスト) GET、PUT、DELETEなど
  • 冪等でないリクエスト(=リクエストを繰り返すと意味が変わってくるもの)POST、PATCHなど

ということで、データベースなど状態を持たず、引数だけから値を返すのであればそれは冪等な操作なので、GETリクエストで構築するのが適当だと考えます(もちろん、パラメータが多すぎる、あるいはファイルも送る等の場合、GETで素直に流せませんが、それは別問題です)。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/04/19 11:00

    なるほど。
    ありがとうございます。冪等であるかどうかが鍵なのですね。
    わかりやすい説明をありがとうございます。

    第二の質問について、apiの命名はどのようにすればいいかも、
    よろしければ教えて頂けたらと思います。
    僕の理解では、名詞の複数形を用いるのが、データベース等にアクセスする作法です。
    今回のような、場合は、動詞+名詞(increment_num)にするべきでしょうか。
    それとも、動詞だけ(increment)。
    もしくは、動詞+型情報(increment_int)。
    もし、正解がなければmiisumakun様の経験よりの回答を頂けたらと思います。

    キャンセル

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

  • ただいまの回答率 90.35%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

同じタグがついた質問を見る

  • Ruby on Rails

    7666questions

    Ruby on Railsは、オープンソースのWebアプリケーションフレームワークです。「同じことを繰り返さない」というRailsの基本理念のもと、他のフレームワークより少ないコードで簡単に開発できるよう設計されています。

  • Webサーバー

    458questions

    Webサーバーとは、HTTPリクエストに応じて、クライアントに情報を提供するシステムです。

  • Express

    259questions

    ExpressはNode.jsのWebアプリケーションフレームワークです。 マルチページを構築するための機能セットおよびハイブリッドのWebアプリケーションを提供します。