API設計まとめ - Qiita

はじめに 自分は2021年に新卒でWeb系の開発会社にフロントエンジニアとして入社し2022年で2年目になります。 実務ではReact×TypeScriptを利用したフロント周りとNode.js(Nest)やRailsを用いたバックエンド(API)の開発をしています。 その中で使っていたAPI設計について改めて学び直したのでまとめて行きます。 この記事の対象者 エンジニア初心者から中級者 APIについて学びを深めたい人 この記事の目標 APIについて学ぶ 我流ではなく正しいAPI設計について学ぶ この記事でやらないこと 具体的にコードを用いたAPI設計の書き方の説明に関しては下記の記事で解説をしています。 APIについて APIとは APIは"Application Programming Interface"の略で、直訳すると「アプリケーションを使プログラミングを使ってつなぐ」という意味

[gotin]

明らかにWeb API設計のまとめ、な気が。APIってWeb APIだけじゃないよね。

[tyosuke2011]

うわむず！

[mk_55]

十分か？と言われると違う気がするが、ジュニア向けにとりあえず読んどけという出発点としては良くまとまっているのではなかろうか。

[remonoil]

"ネスト構造を減らす" 程度の問題が難しくて、常にflatにするのが正義になってしまうしDB設計もそれに引きずられてカラム大量になる。なった。 / RFC3339って何かと思ったISO8601か

[nazoking]

微妙なルールが混ざっててこれ規範にされるとやだなー

[kazkun]

ああ、パラメータの考え方とか有るといいなと思ったけどやっぱりそこまでは無理だったか。

[rkosaka]

APIというよりはHTTPなWebAPIの話。

[ku__ra__ge]

RESTful概念にフィットしない機能はどうやればええんや……。ログイン/ログアウトとか。

[tamanecoplus]

更新は PUT => UPSERT、PATCH => 元データ必須なUPDATEと認識してる

[strawberryhunter]

一部オレオレルールが混ざってるけど、基礎から整理されている。