by Hatena

Slide 1

Slide 1 text

Web API IBUFOBJOUFSO !

Slide 2

Slide 2 text

͜ͷߨٛͷ໨త • Web API を⽀えるプロトコル (HTTP) について知る • Web API の種類を知り、俯瞰できるようになる IBUFOBJOUFSO !

Slide 3

Slide 3 text

ϓϩτίϧ • = 約束ごと • TCP/IP, HTTP, DNS, TLS, SMTP, 3 • インターネットの参加者はプロトコルに従っている • サーバ（Google やはてな） • クライアント（ブラウザ、スマートフォンアプリ） • ルータ、… • これらのプロトコルは RFC によって定義される • = Request for Comments IBUFOBJOUFSO !

Slide 4

Slide 4 text

γϯλοΫεͱηϚϯςΟΫε • シンタックス（Syntax） • プロトコルの参加者が、どんなフォーマットでやりとりするか • セマンティクス（Semantics） • シンタックスに従ってやりとりされるデータをどう解釈するか IBUFOBJOUFSO !

Slide 5

Slide 5 text

HTTP Hypertext Transfer Protocol IBUFOBJOUFSO !

Slide 6

Slide 6 text

Hypertext Transfer Protocol http://www.example.com/ • ハイパーテキスト • リンクしたり画像を埋め込んだりできるテキスト • HTML によって表現されるもの • …のためのプロトコル IBUFOBJOUFSO !

Slide 7

Slide 7 text

HTTP ͷλΠϜϥΠϯ 1991 HTTP/%.' 1996 HTTP/%.' 1997 HTTP/%.% 2009 Google が SPDY を発表 2013 Google が QUIC を発表 2015 SPDY を元にしたHTTP/%の標準化 2018 HTTP-over-QUIC を HTTP/%に改名 2021 QUIC の標準化 2022 HTTP/% の標準化 IBUFOBJOUFSO !

Slide 8

Slide 8 text

HTTP/1.1: HTTP ͷجૅ • RFC &''(: HTTP Semantics • RFC &''': HTTP Caching • RFC &''8: HTTP/'.' • Deprecated: • RFC 8(?@ Hypertext Transfer Protocol -- HTTP/'.' • RFC 8?'? Hypertext Transfer Protocol -- HTTP/'.' • RFC G8H( Hypertext Transfer Protocol (HTTP/'.'): Message Syntax and Routing • RFC G8H' Hypertext Transfer Protocol (HTTP/'.'): Semantics and Content • RFC G8H8 Hypertext Transfer Protocol (HTTP/'.'): Conditional Requests • RFC G8HH Hypertext Transfer Protocol (HTTP/'.'): Range Requests • RFC G8HN Hypertext Transfer Protocol (HTTP/'.'): Caching • RFC G8HO Hypertext Transfer Protocol (HTTP/'.'): Authentication IBUFOBJOUFSO !

Slide 9

Slide 9 text

Uniform Resource Locator (URL) • ブラウザで「開く」と… • HTTP(S) でリソースを取得する • motemen.hatenablog.com の 443 ポート • /search?q=git • データ (HTML) を解釈して表⽰する IBUFOBJOUFSO !

Slide 10

Slide 10 text

ਓؒ΋ HTTP/1.1 Λ஻ͬͯΈΔ • http://hatena.blog/ へのアクセス $ nc hatena.blog 80 GET / HTTP/1.1 Host: hatena.blog ↵ IBUFOBJOUFSO !"

Slide 11

Slide 11 text

HTTP/1.1 301 Moved Permanently Server: CloudFront Date: Mon, 28 Jul 2025 03:00:19 GMT Content-Type: text/html Content-Length: 167 Connection: keep-alive Location: https://hatena.blog/ X-Cache: Redirect from cloudfront Via: 1.1 0813d806b3dfe883cf8cfb0f711fd4ec.cloudfront.net (CloudFront) X-Amz-Cf-Pop: KIX56-P3 X-Amz-Cf-Id: -uMcBBc0Hyr2nrpWSAJZ4p-4mA8RPrzgM-t6SOUejkivv_ekknmmLA== 301 Moved Permanently

301 Moved Permanently

CloudFront IBUFOBJOUFSO !!

Slide 12

Slide 12 text

HTTPS ΋஻ͬͯΈΔ • HTTP over TLS • https://hatena.blog/ へのアクセス $ openssl s_client -connect hatena.blog:443 GET / HTTP/1.1 Host: hatena.blog ↵ IBUFOBJOUFSO !"

Slide 13

Slide 13 text

HTTP ͷεΠεΞʔϛʔφΠϑ: curl $ curl --head --location --verbose http://hatena.blog/ > HEAD / HTTP/1.1 > Host: hatena.blog > User-Agent: curl/8.7.1 > Accept: */* > < HTTP/1.1 301 Moved Permanently ... curl --help all で楽しもう IBUFOBJOUFSO !"

Slide 14

Slide 14 text

HTTP ͷηϚϯςΟΫε • リクエスト • メソッドとターゲット • レスポンス • ステータス • 共通 • ヘッダー • ボディ IBUFOBJOUFSO !"

Slide 15

Slide 15 text

HTTP/1.1 γϯλοΫε ϦΫΤετ HTTP/1.1 : Ϩεϙϯε HTTP/1.1 000 : IBUFOBJOUFSO !"

Slide 16

Slide 16 text

ϦΫΤετߦ HTTP/1.1 GET POST PUT HEAD DELETE OPTIONS TRACE CONNECT PATCH /entry/1 /search?q=text / HTTP/1.0 HTTP/1.1 IBUFOBJOUFSO !"

Slide 17

Slide 17 text

εςʔλεߦ HTTP/1.1 000 Reason • 1xx Informational • 2xx Successful • 3xx Redirection • 4xx Client Error • 5xx Server Error IBUFOBJOUFSO !"

Slide 18

Slide 18 text

ϘσΟ HTML ... JSON { "id": "42", "created": 1723707520, ... } PNG ը૾ ?PNG\0d\1a\00\00\00\0dIHDR... IBUFOBJOUFSO !"

Slide 19

Slide 19 text

ϔομʔ Host: hatena.blog Content-Type: text/html Content-Length: 167 Location: https://hatena.blog/ • メッセージを拡張したり、メタデータとして機能したり IBUFOBJOUFSO !"

Slide 20

Slide 20 text

Content-Type • Content-Type: text/html — HTML • Content-Type: application/json — JSON • Content-Type: image/png — PNG 画像 IBUFOBJOUFSO !"

Slide 21

Slide 21 text

ίϯςϯτωΰγΤʔγϣϯ 同じ URL へのアクセスでも… • Accept: text/html • リンク遷移など • Accept: image/* • 要素からのリクエストなど IBUFOBJOUFSO !"

Slide 22

Slide 22 text

ϘσΟͷѹॖ • クライアント Accept-Encoding: gzip, deflate • サーバ Content-Encoding: gzip • gzip • compress • deflate • identity • br IBUFOBJOUFSO !!

Slide 23

Slide 23 text

ΫοΩʔ ! • サーバ Set-Cookie: key=value; Expires=Wed, 09 Jun 2024 10:18:14 GMT • クライアント Cookie: key=value • HTTP は本来ステートレス →「セッション」の導⼊ • ブラウザにクッキーを⾷べさせることで次回以降のリクエストに情報を持ち越す IBUFOBJOUFSO !"

Slide 24

Slide 24 text

ೝূ ! Authorization: Basic xxxx Authorization: Bearer yyyy IBUFOBJOUFSO !"

Slide 25

Slide 25 text

Ωϟογϡ ! Cache-Control: public, max-age=14400 Cache-Control: private Vary: Accept-Encoding • 単体で RFC ができる程度には話題が多い • RFC 4555: HTTP Caching IBUFOBJOUFSO !"

Slide 26

Slide 26 text

HTTP/2 RFC %&'( Hypertext Transfer Protocol Version ; (HTTP/;) IBUFOBJOUFSO !"

Slide 27

Slide 27 text

HTTP/1.1 ͷ໰୊఺ • 背景: 複雑化する Web アプリケーション環境 • たくさんのアセット (JavaScript、画像、…) • モバイル機器からのアクセス • リクエスト-レスポンスのやりとりが TCP コネクションを専有 • ドメインあたりのコネクションは 6 つほどに制限されている • 「重い」リクエストがあると次のリクエストができない • ヘッダーの冗⻑性 IBUFOBJOUFSO !"

Slide 28

Slide 28 text

IBUFOBJOUFSO !"

Slide 29

Slide 29 text

HTTP/2 • セマンティクスは HTTP//./ と共通 • バイナリフレームでやりとり • ひとつの TCP コネクションを複数のストリームに分割 • 複数のリソースを⼀度にやり取りできる • 複雑な制御ができる • ヘッダーも圧縮 IBUFOBJOUFSO !"

Slide 30

Slide 30 text

HPACK RFC %&'( HPACK: Header Compression for HTTP/; Index Header Name Header Value / :authority 0 :method GET 1 :method POST 2 :path / 3 :path /index.html 4 :scheme http 5 :scheme https 6 :status 200 IBUFOBJOUFSO !"

Slide 31

Slide 31 text

HTTP/3 • QUIC トランスポート • UDP 上に TCP と TLS の機能を再現 • HTTP-over-QUIC • HTTP/B を QUIC トランスポート上で実装 • QPACK • コネクションマイグレーション $ open https://http3.is IBUFOBJOUFSO !"

Slide 32

Slide 32 text

HTTP • セマンティクス • HTTP/-.- • シンタックス • HTTP/2, HTTP/5 • モチベーション • 仕組み IBUFOBJOUFSO !"

Slide 33

Slide 33 text

API Application Programming Interface IBUFOBJOUFSO !!

Slide 34

Slide 34 text

Application Programming Interface • OS ⇔ アプリケーション • glibc: システムコール • ブラウザ ⇔ JavaScript アプリケーション • DOM (Document Object Model): HTML ⽂書を JS から操作 • Web サービス ⇔ Web フロントエンド、アプリ、別システム • REST • GraphQL • gRPC IBUFOBJOUFSO !"

Slide 35

Slide 35 text

LSUDs (Large Set of Unknown Developers) • 最⼤公約数的な API を提供する SSKDs (Small Set of Known Developers) • クライアントに最適化した API を提供する IBUFOBJOUFSO !"

Slide 36

Slide 36 text

API • REST • GraphQL • gRPC IBUFOBJOUFSO !"

Slide 37

Slide 37 text

REST Representational State Transfer • HTTP の仕組みをうまく使う • リソース指向 https://api.github.com/repos/hatena/example/issues/1 IBUFOBJOUFSO !"

Slide 38

Slide 38 text

CRUD HTTP メソッド Create POST Read GET Update PUT / PATCH Delete DELETE IBUFOBJOUFSO !"

Slide 39

Slide 39 text

ྫ: GitHub ͷΠγϡʔίϝϯτ • POST /repos/:owner/:repo/issues/:issue_number/comments • GET /repos/:owner/:repo/issues/comments/:comment_id • PATCH /repos/:owner/:repo/issues/comments/:comment_id • DELETE /repos/:owner/:repo/issues/comments/:comment_id IBUFOBJOUFSO !"

Slide 40

Slide 40 text

REST ͷΤϥʔϨεϙϯε • 厳密な制約はない • HTTP ステータスコードによる表現 • 例: レートリミットを超えた → 429 Too Many Requests • RFC TUVW: Problem Details • エラーレスポンスの形式を定める IBUFOBJOUFSO !"

Slide 41

Slide 41 text

OpenAPI • Swagger • REST API を記述するための仕様 • コード⽣成‧ドキュメント⽣成にも使える • 例: https://github.com/openai/openai-openapi IBUFOBJOUFSO !"

Slide 42

Slide 42 text

REST API ͷόʔδϣχϯά • path にバージョン番号を⼊れる • 例: X (旧 Twitter) • GET /A.A/statuses/show/:id • GET /G/tweets/:id IBUFOBJOUFSO !"

Slide 43

Slide 43 text

REST ͷಛ௃ • 実装や原則がシンプル • 道具なく作りはじめられる • REST「⾵」になりがちではある • Accidentally RESTful という表現もある • クライアント側から使いにくくなりがち • オーバーフェッチ、アンダーフェッチ • 要求の変化への対応が難しくなりがち IBUFOBJOUFSO !"

Slide 44

Slide 44 text

API • REST • GraphQL • gRPC IBUFOBJOUFSO !!

Slide 45

Slide 45 text

GraphQL • Facebook (現 Meta) によって開発された • クライアント側から必要なフィールドを指定する • スキーマからのコード⽣成ができる IBUFOBJOUFSO !"

Slide 46

Slide 46 text

SDL (Schema Deﬁnition Language) type Query { blog(id: String!): Blog } type Blog { title: String! entries(first: Int!): [Entry!]! } type Entry { title: String! body: String! name: String @deprecated(reason: "Use `title`.") } IBUFOBJOUFSO !"

Slide 47

Slide 47 text

εΧϥʔܕ Int Float String Boolean ID 独⾃のスカラー型を定義することもできる IBUFOBJOUFSO !"

Slide 48

Slide 48 text

ΦϒδΣΫτܕ type Blog { title: String! entries(first: Int!): [Entry!]! } ! がつくと non-nullable [T] はリスト型 IBUFOBJOUFSO !"

Slide 49

Slide 49 text

interface interface Publication { body: String! } type Entry implements Publication { body: String! comments: [Comment!]! } type Page implements Publication { body: String! } IBUFOBJOUFSO !"

Slide 50

Slide 50 text

union union EntryOrPage = Entry | Page IBUFOBJOUFSO !"

Slide 51

Slide 51 text

Query type Query { blog(id: String!): Blog } • リソースを取得する IBUFOBJOUFSO !"

Slide 52

Slide 52 text

Mutation type Mutation { createBlog(input: CreateBlogInput!): Blog } input CreateBlogInput { title: String! } • リソースを更新する IBUFOBJOUFSO !"

Slide 53

Slide 53 text

Subscription type Subscription { entryPosted(blogId: ID!): Entry } • リソースに変更があったことをリアルタイムに受信する IBUFOBJOUFSO !"

Slide 54

Slide 54 text

ྫ: GitHub API ΁ͷΫΤϦ $ gh api graphql --verbose -f query='query { viewer { login repositories(last: 3, visibility: PUBLIC) { nodes { name } } } }' { "data": { "viewer": { "login": "utgwkk", "repositories": { "nodes": [ { "name": "20241217-sketch-mysql-and-goqu" }, { "name": "autonolint" }, { "name": "terraform-provider-aws" } ] } } } } IBUFOBJOUFSO !"

Slide 55

Slide 55 text

GraphQL εΩʔϚઃܭͷίπ • リソース間の関係を⾃然にたどれるようにする • Mutation が返す専⽤の型を導⼊する • GraphQL Server Speciﬁcation に準拠する IBUFOBJOUFSO !!

Slide 56

Slide 56 text

Ϧιʔεؒͷؔ܎ΛࣗવʹͨͲΕΔΑ͏ʹ͢Δ type User { name: String! blogs: [Blog!]! } type Blog { entries(first: Int!): [Entry!]! } type Entry { body: String! comments(first: Int!): [Comment!]! } type Comment { body: String! user: User } IBUFOBJOUFSO !"

Slide 57

Slide 57 text

Mutation ͕ฦ͢ઐ༻ͷܕΛಋೖ͢Δ type Mutation { createBlog(input: CreateBlogInput!): CreateBlogPayload } type CreateBlogPayload { blog: Blog } • 更新対象のエンティティをまとめて返す • 付加情報を返す IBUFOBJOUFSO !"

Slide 58

Slide 58 text

GraphQL Server Speciﬁcation • Relay がスキーマに要求する追加仕様 • Node インタフェース • リソースを ID で直接取得する • Connection • ページネーション (継ぎ⾜し読み込み) IBUFOBJOUFSO !"

Slide 59

Slide 59 text

Node ΠϯλϑΣʔε interface Node { id: ID! } type Query { node(id: ID!): Node } IBUFOBJOUFSO !"

Slide 60

Slide 60 text

Connection type EntryConnection { edges: [EntryEdge!]! pageInfo: PageInfo! } type EntryEdge { cursor: String! node: Entry! } type PageInfo { hasNextPage: Boolean! hasPreviousPage: Boolean! startCursor: String endCursor: String } type Blog { entries( first: Int, last: Int, before: String, after: String, ): EntryConnection! } IBUFOBJOUFSO !"

Slide 61

Slide 61 text

GraphQL ͱޓ׵ੑ • クライアントが参照していないフィールドを⾃由に追加できる • Query/Mutation/Subscription も同様 • クライアントが参照しているフィールドを変更‧削除すると互換性が壊れる • 型やフィールドを分ける • @deprecated を活⽤する IBUFOBJOUFSO !"

Slide 62

Slide 62 text

@deprecated directive type Entry { title: String! body: String! name: String @deprecated(reason: "Use `title`.") } IBUFOBJOUFSO !"

Slide 63

Slide 63 text

πʔϧηοτͷαϙʔτ • サーバ • スキーマからのコード⽣成 • リゾルバの実装 • クライアント • UI ライブラリとの連携 • 型定義の⽣成 • キャッシュの管理 • GraphiQL IBUFOBJOUFSO !"

Slide 64

Slide 64 text

GraphQL ͷಛ௃ • クライアントは必要⼗分なデータを取得できる • クライアントはスキーマに基づいてリクエストを組み⽴てる • サーバ側は複雑になりがち • N+N クエリ • Dataloader • ⾃由に書けすぎるので制限が必要 • クエリの複雑度に上限を設ける • Persisted Query • ログ‧トレーシング IBUFOBJOUFSO !"

Slide 65

Slide 65 text

API • REST • GraphQL • gRPC IBUFOBJOUFSO !"

Slide 66

Slide 66 text

gRPC • Google によって開発された • RPC (Remote Procedure Call) のためのシステム • 定義ファイルからのコード⽣成 • HTTP/S ベース • 双⽅向ストリーミングもサポート IBUFOBJOUFSO !!

Slide 67

Slide 67 text

Protocol Buffers • 構造化されたデータをシリアライズする仕組み • バイナリフォーマット • IDL (Interface Description Language) • .protoファイル • RPC をサポートしている IBUFOBJOUFSO !"

Slide 68

Slide 68 text

gRPC ͱ Protocol Buffers • gRPC = Protocol Buﬀers を使うプロトコルではない • シリアライズ⽅式はなんでもいい • Protocol Buﬀers を使うと楽、ということは⾔及されている IBUFOBJOUFSO !"

Slide 69

Slide 69 text

syntax = "proto3"; package account; service Account { rpc Signup(SignupRequest) returns (SignupReply); } message SignupRequest { string name = 1; string password = 2; } message SignupReply { string token = 1; } IBUFOBJOUFSO !"

Slide 70

Slide 70 text

ϝοηʔδܕ message SignupRequest { string name = 1; string password = 2; } ϑΟʔϧυܕ ϑΟʔϧυ໊ = ϑΟʔϧυ൪߸; • フィールド番号が重要 IBUFOBJOUFSO !"

Slide 71

Slide 71 text

ޓ׵ੑ • フィールド番号 int32 old_field = 6 [deprecated = true]; reserved 2, 15, 9 to 11; reserved "foo", "bar"; IBUFOBJOUFSO !"

Slide 72

Slide 72 text

Protocol Buffers ͷόʔδϣχϯά パッケージ名によってバージョニングを実現 • 例: Firestore RPC API • google.ﬁrestore.v6 • google.ﬁrestore.v6beta6 IBUFOBJOUFSO !"

Slide 73

Slide 73 text

αʔϏεͱετϦʔϜ service RouteGuide { rpc GetFeature(Point) returns (Feature) {} rpc ListFeatures(Rectangle) returns (stream Feature) {} rpc RecordRoute(stream Point) returns (RouteSummary) {} rpc RouteChat(stream RouteNote) returns (stream RouteNote) {} } IBUFOBJOUFSO !"

Slide 74

Slide 74 text

RPC ͷछྨ (1) • Unary RPCs (SimpleRPC) • single request single response • シンプルな通信 • Server streaming RPC • クライアント側はすべてのメッセージを受信すると処理を完了する IBUFOBJOUFSO !"

Slide 75

Slide 75 text

RPC ͷछྨ (2) • Client streaming RPC • クライアント側は複数のメッセージを送り単⼀のメッセージを受信する • Bidirectional streaming RPC • 双⽅向ストリーミングのこと • クライアント側とサーバー側のストリームは独⽴している • そのためそれぞれ任意の順序でメッセージの読み書きができる IBUFOBJOUFSO !"

Slide 76

Slide 76 text

gRPC ʹ͓͚Δ API ઃܭ CRUD + List • CreateEntity • GetEntity • UpdateEntity • DeleteEntity • ListEntities IBUFOBJOUFSO !"

Slide 77

Slide 77 text

API • いくつかの API について⾒てきた • REST • GraphQL • gRPC • 特徴とトレードオフを理解して使おう IBUFOBJOUFSO !!

Slide 78

Slide 78 text

͓ΘΓ IBUFOBJOUFSO !"

Slide 79

Slide 79 text

ࢀߟࢿྉ IBUFOBJOUFSO !"

Slide 80

Slide 80 text

HTTP • HTTP の概要 - HTTP | MDN • HTTP の進化 - HTTP | MDN • Set-Cookie - HTTP | MDN • SameSite属性とCSRFとHSTS - Cookieの基礎知識からブラウザごとのエッジケースまでおさらいする - GMO Flatt Security Blog • Real World HTTP 第3版―歴史とコードに学ぶインターネットとウェブ技術 • Web配信の技術―HTTPキャッシュ‧リバースプロキシ‧CDNを活⽤する IBUFOBJOUFSO !"

Slide 81

Slide 81 text

REST • Fielding Dissertation: CHAPTER 8: Representational State Transfer (REST) • REST という概念が初めて提唱された論⽂ • GitHub REST API documentation - GitHub Docs • API Reference - OpenAI API • Web API: The Good Parts IBUFOBJOUFSO !"

Slide 82

Slide 82 text

GraphQL • GraphQL Speciﬁcation (October 5657 Edition) • GraphQL Server Speciﬁcation | Relay • Relayに学ぶGraphQLのスキーマ設計 - cockscomblog? • 初めての GraphQL―Webサービスを作って学ぶ新世代API IBUFOBJOUFSO !"

Slide 83

Slide 83 text

gRPC (Protocol Buffers) • Introduction to gRPC | gRPC • Language Guide (proto 7) | Protocol Buﬀers Documentation • gRPC over HTTPB • Cloud Firestore API | Google Cloud • HTTP/B と gRPC に対するよくある誤解。 - ねののお庭。 IBUFOBJOUFSO !"