Stack Map新人 Web エンジニアの地図

API は、画面ではなくデータをやりとりするための窓口です。使う人が迷わず、間違えにくく、あとから変えやすい窓口を作るための決まりごとを、実際に叩ける練習台つきでまとめました。
HTTP のやりとりの基本は Web の仕組みにあります。

API とは

画面(HTML)ではなく、データ(JSON など)を出し入れする窓口です。1 つの API を、いろいろな相手が使います。返事の形の基本は Web の仕組みの「Web API」へ。

REST の設計の基本

URL で「何を」、メソッドで「どうする」を表します。本(books)を例にすると、6 つの組み合わせでたいていのことができます。状態コードの意味は Web の仕組みの状態コードへ。

基本の 6 つ

入れ子(だれの何か)

API を叩いてみる(練習台)

作り物の「本のお店」の API です。上のボタンで例を選ぶか、メソッド・URL・だれとして送るか・中身を自分で決めて「送る」を押すと、返事が出ます。本を足したり消したりすると、右下のお店の中身が本当に変わります(このページの中だけの作り物です)。

実際に送るもの

        
いまのお店の中身(サーバーの中)

よい設計の決まりごと

使う人が迷わず、間違えにくくするための決まりです。出典のあるものは、規格や大きなサービスのやり方を載せています。

API の種類を比べる

REST だけが API ではありません。やりとりの形によって、向いている種類が違います。

説明書(OpenAPI)

API は、使い方が伝わらなければ使ってもらえません。説明書を決まった形で書いておくと、人にも道具にも伝わります。

あとから変えるとき(壊さない変え方)

公開した API は、だれがどう使っているか全部は分かりません。使っている人のプログラムを壊さない変え方を選びます。

守り(OWASP API Security Top 10)

API に特有の危ない所を、OWASP がまとめた一覧(2023 年版)です。1 位は「ID を書き換えるだけで他人のデータが見える」で、OWASP は「広く見られる」と評価しています。毎回、サーバーの側で「この人が見てよいか」を確かめます。攻撃の全体は セキュリティのページへ。

AI 時代の API

AI を API で呼ぶだけでなく、AI が API を呼ぶ時代になりました。API の作り方も、それに合わせて変わります。

やりがちなミス(チェックリスト)

自分の API を確かめたら、チェックを付けてみてください(この端末にだけ保存されます)。