API設計スキルを次のレベルに引き上げるベストプラクティス22選 - Qiita

本記事は、Mohammad Faisal氏による「22 Best Practices to Take Your API Design Skills to the Next Level」（2021年4月15日公開）の和訳を、著者の許可を得て掲載しているものです。 REST API設計のための実践的アドバイス Photo by Andrea Piacquadio from Pexels はじめに すべてが分かりにくく、ひどいAPIに不満を感じたことはありませんか？私はそうです。 マイクロサービスの世界では、バックエンドAPIの一貫した設計が不可欠です。 今日は、知っておくべきベストプラクティスについて、簡潔に説明します。さあ始めましょう！ 用語 API設計は、リソース指向設計というものに従います。3つの重要な概念で構成されています。 リソース：データの一部（例：ユーザー） コレクション：リソー

[turanukimaru]

RESTは始まりが割と適当なので規格化が甘いため、こうやってベストプラクティスがまとまってるだけでも意味はあるのではなかろうか。というかどこかおかしい？具体的に教えてもらえたら記事のコメで指摘してくるよ。

[murlock]

命名が統一されているのは大事だけど、ここはケバブ、ここはキャメルって理由も提示せずに「ベストプラクティス」名乗るのは宗教戦争にも及ばない雑さよ

[slash_01]

API設計するときはいつもGoogleのガイドみてる。 https://cloud.google.com/apis/design

[yuuAn]

パラメータが何ケースかは API 使う側に関係あるのか？

[vuy]

なにが質が低いかって海外のDeveloperComunityからバズりそうな記事みつけて翻訳した記事があがってくることだよ。このbaby-deguって集団は自分で学んだことはなにもないのか？

[inductor]

記事の内容自体は読んだけどまあ悪くなさそう。ただ翻訳活動をQiitaでやっていることに違和感を覚えるんだよなぁ。「(Qiitaの定義する)エンジニアに関する知識を記録・共有」ではなくないか？

[metatrading]

具体的な言及もせず質が悪いと言う人の言葉を信用できるのだろうか。さぞかしどこかで立場のある人なんだろう。 反論記事とか書いて欲しいね。

[nekoruri]

宗教をベストプラクティスと書くと戦争が起きる。歴史を見ればわかる。

[diveintounlimit]

理由を書いてないのはクソだが妙な点はぱっと見なさそう。ただの翻訳なので翻訳元の記事がクソという話。

[junglejungle]

良い悪いの理屈くらい書いて欲しいんだが。単に業界で統一したいので推奨しますってだけ？

[kazoo_oo]

理由がほしいものが多い

[tettekete37564]

サーバーサイドに使う言語に何を使うか選択用チャート作ってくれ

[chiroruxx]

ハイフネーションとスネークケースは使い分けましょう

[iww]

そもそもRESTfulな設計とか思想が嫌い。 PUTとかDELETEとかなんで復活させたん

[toro-chan]

次のレベルに引き上げる、という意味ではまあまとまってると思う。ここのレベルはあまり理由を考える必要がない。次のレベルでは、いろいろな理由を考慮する必要があるのだろう。その意味で次を見たい。。

[remonoil]

理由を書け、理由を。

[junki_au]

実践的でいいね。

[messzylinder]

アンスコだと単語の区切りを認識できないというGoogleの都合のようであるが、ホスト名にアンスコつかえないので、統一という意味ではハイフンのほうが良いということか

[urza358]

“3”

[raamen07]

ベストプラクティスって言うか設計方針

[otherworld]

offset/limit、総件数を含めるかどうか、非リソースの動詞はこの手のガイドラインでも一律で「すべき」とまでしてない気がするのと、パスパラメータ名がキャメルケースというのは実装の話じゃないかな。

[arx0balest]

まぁ概ね悪くないんじゃないだろうか。いくつか個人的な見解の相違はあったが。

[Cherenkov]

googleのマネすればええ

[koriym]

全ての項目においてRESTと無関係

[sirobu]

後ろの方の項番ほど納得感がある。というか、序盤の命名規約の理由が知りたい

[NetPenguin]

この記事に直接は関係無いけど、集合を表す時に末尾スラッシュではなく複数形を使えっていうの、時々目にする。だけど、末尾のスラッシュを特別扱いする事と、末尾のsを特別扱いする事に差は無いのでは？と思う。

[you121212]

]

[onesplat]

Qiitaというのは質の低い記事を集めて晒すミッションでも負っているのだろうか。ほんと最低レベルのコンテンツしかないよな。読まないでいいよこんなの。むしろ読まないほうがいい