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

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

ただいまの
回答率

90.51%

  • Ruby on Rails 5

    1783questions

  • API

    1527questions

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

APIの数が膨大なになった時のAPI名の付け方について

解決済

回答 1

投稿

  • 評価
  • クリップ 2
  • VIEW 183

tomo1986

score 2

 RESTfulなAPIで構築APIを作成したい。

下記で記載する内容をどのように解決しているのかの質問と、
どのようにAPIを設計すれば下記のような問題を回避できるのか、
RESTfulなAPIで構築できるのか教えていただきたいです。

 発生している問題

現在私の会社ではAPIの名前はapi1,api2,api3というような名前でapiを書いています。
apiを呼ぶ時、api/v1/api1みたいな感じです。
これだと何の何をするapiかわからないのです。

なぜこういう名前にしたかというと理由は二つあります。
・昔apiの数が膨大になった頃、一つ一つに適切な名前をつけることが困難になったから
・更新するプログラムで子テーブルの要素まで更新する場合、適切な名前が思いつかなくなった。

上記二つの理由から私の会社ではapi{n}という名前でapiを作ることが文化になりました。

また、APIを作る上で制約等がないためメンバーは、本来getメソッドが正しいところでもpostを使用したりと作る人によってバラバラです。

だから私はどうにかメンテナビリティが高くできないかということやRESTfulなAPIを作るにはどうしたらよいかを考えていて、
上司に相談すると、考えた結果api{n}という名前でapiを作ることを決断したとのことでした。

色々調べましたが、私たちと同じように作成している事例を聞いたことないし調べても出てきませんでした。

実際私たちのサービスよりも大きいサービスでAPIの数も私たちのサービスよりも多いサービスはいっぱいあると思います。
「apiの数が膨大になり、一つ一つに適切な名前をつけることが困難」という問題も当然あるとと思います。

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

質問への追記・修正、ベストアンサー選択の依頼

  • SurferOnWww

    2018/07/16 10:00

    マルチポストのようですので、他のポスト先の URL を貼っておきます。 https://qa.atmarkit.co.jp/q/10566

    キャンセル

  • SurferOnWww

    2018/07/16 10:04

    質問者さんへ> マルチポストの意味が不明でしたらそれでググってヒットする記事を 2, 3 読んでください。いろいろ意見はあるかもしれませんが、ここのようなコミュニティで歓迎されることではなさそうです。

    キャンセル

回答 1

checkベストアンサー

+3

APIに限らずネーミングは大切です。変数ひとつにしてもその機能や用途が想像できるネーミングでなければなりません。その為にはなるべく早い段階から将来も含めてこんなAPIを提供したい、というリストを用意しましょう。

機能や用途も記述したAPIの一覧も提供しましょう。APIの数が多くなってもある程度用途毎に分類できるはずです。ネーミングに連番を使うのはネーミングを定義できる桁数の上限など最後の手段です。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2018/07/16 12:37

    なるほどですね。
    機能や用途も記述したAPIの一覧作ってなかったです。
    ありがとうございます。

    キャンセル

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

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

関連した質問

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

  • Ruby on Rails 5

    1783questions

  • API

    1527questions

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