Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
つ・な・が・り・た・い REST_APIのお話
Search
kirimaru
October 07, 2019
Programming
0
2.6k
つ・な・が・り・た・い REST_APIのお話
kirimaru
October 07, 2019
Tweet
Share
More Decks by kirimaru
See All by kirimaru
早くAPI作るならFastAPI がオススメ
hirotokirimaru
1
70
DDD(ドメイン駆動設計)を知らない人に知ったつもりさせる/Introduce_DDD_to_unfamiliar_individuals
hirotokirimaru
0
330
例示! Spring Bootで作られた REST APIのテストコード/ Testing-Example-for-a-REST-API-created-with-Spring-Boot
hirotokirimaru
2
2k
一緒に使うことが多い値は別クラスにしよう(Data Clumps)/data_clumps_is_useful
hirotokirimaru
0
750
Backlogが好きな話。/i_like_backlog
hirotokirimaru
0
150
私が好きなポートアンドアダプターを紹介する/I-like-hexagonal-architecture.pdf
hirotokirimaru
1
1.2k
名付けのためにクラス図を元に会話しよう/Let's-use-class-diagram-to-communicate-with-client
hirotokirimaru
0
640
Code Smellsの Primitive Obsession に気を付けて設計する/Designing-with-Code-Smells-Primitive-Obsession
hirotokirimaru
1
3.5k
FCCを推す/My favorite software architecture is FCC
hirotokirimaru
0
240
Other Decks in Programming
See All in Programming
When Dependencies Fail: Building Antifragile Applications in a Fragile World
selcukusta
0
110
実践Claude Code:20の失敗から学ぶAIペアプログラミング
takedatakashi
18
8.1k
Google Opalで使える37のライブラリ
mickey_kubo
3
140
Go言語はstack overflowの夢を見るか?
logica0419
0
520
なぜGoのジェネリクスはこの形なのか? - Featherweight Goが明かす設計の核心
qualiarts
0
240
テーブル定義書の構造化抽出して、生成AIでDWH分析を試してみた / devio2025tokyo
kasacchiful
0
270
monorepo の Go テストをはやくした〜い!~最小の依存解決への道のり~ / faster-testing-of-monorepos
convto
2
530
Go言語の特性を活かした公式MCP SDKの設計
hond0413
1
480
What's new in Spring Modulith?
olivergierke
1
170
iOSでSVG画像を扱う
kishikawakatsumi
0
160
チームの境界をブチ抜いていけ
tokai235
0
210
Migration to Signals, Resource API, and NgRx Signal Store
manfredsteyer
PRO
0
100
Featured
See All Featured
The MySQL Ecosystem @ GitHub 2015
samlambert
251
13k
Designing for humans not robots
tammielis
254
26k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
46
7.7k
StorybookのUI Testing Handbookを読んだ
zakiyama
31
6.2k
Java REST API Framework Comparison - PWX 2021
mraible
34
8.9k
Documentation Writing (for coders)
carmenintech
75
5.1k
Building a Scalable Design System with Sketch
lauravandoore
463
33k
GraphQLとの向き合い方2022年版
quramy
49
14k
Being A Developer After 40
akosma
91
590k
A Tale of Four Properties
chriscoyier
161
23k
Building an army of robots
kneath
305
46k
Art, The Web, and Tiny UX
lynnandtonic
303
21k
Transcript
つ・な・が・り・た・い REST APIのお話 タピオカLT 2杯目 きり丸(nainaistar) 1
自己紹介 水上皓登:きり丸 twitter: @nainaistar github: hirotoKirimaru 通信会社所属 2
昔抱いていたRESTの認識 3
昔抱いていたRESTの認識 ❏ Ajax通信をやるために、RESTって技術使えばいいらしい。 画面表示後にデータ取ってこれる! 画面操作しても再リロードが走らない! だから、UXが向上する! すごいぞ、REST! 4
昔抱いていたRESTの認識 ❏ これは本の管理画面で使うREST APIだから、 本の追加は ”http://domain/bookManage/insertBook”、 本の更新・削除は ”http://domain/bookMange/updateBook”、 本管理画面RestController.javaだ! 5
6
(ちゃんと学んだ) 今のRESTの認識 7
REST ≒ REST API RESTの原則に従ったAPIのこと ▰ APIが一般的にアクセス可能な状態で提供されている ▰ APIのURLはリソースの場所を表現している ▰
リソースに対して、HTTPメソッドで取得、更新等の操作ができる (リソースの操作方法が一般化されている) ▰ APIの処理結果はステータスコードで判断できる ▰ ステートレスで、リクエストごとに独立している 8
APIのURLはリソースの場所を 表現している 9
例) https://api.github.com/users/hirotoKirimaru/ https://api.github.com/users/hirotoKirimaru/repos ただし、検索に関してはsearchという文言が入ることがある https://api.github.com/search/code?q=readme+user:hirotoKirimaru (※) URLはリソースの場所を表現するので 名詞となるのが特徴 10
REST APIはリソース指向。 http://api.domain/books SOAP, gRPC等のRPCはサービス指向。 サービス名/メソッド名とかになる。 http://domain/bookManage/insertBook http://domain/bookManage/updateBook URLはリソースの場所を表現するので 名詞となるのが特徴
11
リソースに対して、 HTTPメソッドで取得、更新等の操作ができる (リソースの操作方法が一般化されている) 12
リソースに対して、HTTPメソッド で操作ができる 13 HTTP 機能 CRUD GET 取得 SELECT POST
更新(登録) UPDATE(INSERT) PUT 登録 INSERT DELETE 削除 DELETE PATCH 更新 UPDATE
❏ APIの処理結果は ステータスコードで判断できる ❏ APIが一般的にアクセス可能な状態で 提供されている 14
APIの処理結果は ステータスコード で判断できる 15 HTTP_STATUS 内容 100系 情報レスポンス 200系 成功
300系 リダイレクト 400系 クライアントエラー 500系 サーバエラー
SOAP(RPC)は? 16 SOAPの場合、多少のエラーがあっても、ステータスコードは200、 BODYにエラー内容を記載していることがある。 ステータスコードが200以外のパターンは、 リバースプロキシやApacheなどのシステムに繋がらない場合に返却することで、障害 を切り分けられるようにしている。 HTTPを隠蔽してJava等の言語レイヤーだけで 開発できるようにするという思想。(※Real world
Http 141p)
None
None
ステートレスで、 リクエストごとに独立している 19
ステートレスで、 リクエストごとに 独立している 20 GETメソッドは、常に同じ値を返却する。(リソース更新が入らない限り) PUTメソッドは、常に同じ値を登録し続ける。 トランザクションを提供できないので、 トランザクションが必要な単位でなるべく細かいAPIにすることが大事。
その他 21
REST APIに向いているサービス 22
REST APIに向いている サービス 23 ▰ HTTPメソッドで操作しきれないサービス ▰ 例) DropboxはRESTからRPCの提供に変更 ▰
複数のリソースに対してアクセスするAPI ▰ 例) ユーザの投稿、写真、ユーザの友達の写真等々の facebook, instagram等で試用されているGraphQL。
おわり 24
APPENDIX 25
26
参考ページ 27 ▰ https://www.w3.org/TR/soap/ soapは1.2が最新 ▰ Restはとくにない? ▰ https://github.com/graphql/graphql-js/releases graphQLはv14.5.8?
▰ https://github.com/grpc/grpc/blob/master/doc/g_stands_for.md gRPCは1.24が最新_1.25のgは(game)
参考図書 28 Real world Http