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.4k
つ・な・が・り・た・い REST_APIのお話
kirimaru
October 07, 2019
Tweet
Share
More Decks by kirimaru
See All by kirimaru
DDD(ドメイン駆動設計)を知らない人に知ったつもりさせる/Introduce_DDD_to_unfamiliar_individuals
hirotokirimaru
0
220
例示! Spring Bootで作られた REST APIのテストコード/ Testing-Example-for-a-REST-API-created-with-Spring-Boot
hirotokirimaru
2
1.6k
一緒に使うことが多い値は別クラスにしよう(Data Clumps)/data_clumps_is_useful
hirotokirimaru
0
620
Backlogが好きな話。/i_like_backlog
hirotokirimaru
0
100
私が好きなポートアンドアダプターを紹介する/I-like-hexagonal-architecture.pdf
hirotokirimaru
1
750
名付けのためにクラス図を元に会話しよう/Let's-use-class-diagram-to-communicate-with-client
hirotokirimaru
0
570
Code Smellsの Primitive Obsession に気を付けて設計する/Designing-with-Code-Smells-Primitive-Obsession
hirotokirimaru
1
3.1k
FCCを推す/My favorite software architecture is FCC
hirotokirimaru
0
170
我々はなぜオブジェクト指向やDDD等のアーキテクチャを学ぶのか/Why_we_learn_ObjectOriented_and_DDD_Architecture
hirotokirimaru
1
1k
Other Decks in Programming
See All in Programming
リアーキテクチャxDDD 1年間の取り組みと進化
hsawaji
1
220
AWS Lambdaから始まった Serverlessの「熱」とキャリアパス / It started with AWS Lambda Serverless “fever” and career path
seike460
PRO
1
260
受け取る人から提供する人になるということ
little_rubyist
0
250
OSSで起業してもうすぐ10年 / Open Source Conference 2024 Shimane
furukawayasuto
0
110
ActiveSupport::Notifications supporting instrumentation of Rails apps with OpenTelemetry
ymtdzzz
1
250
Make Impossible States Impossibleを 意識してReactのPropsを設計しよう
ikumatadokoro
0
230
型付き API リクエストを実現するいくつかの手法とその選択 / Typed API Request
euxn23
8
2.2k
レガシーシステムにどう立ち向かうか 複雑さと理想と現実/vs-legacy
suzukihoge
14
2.2k
3rd party scriptでもReactを使いたい! Preact + Reactのハイブリッド開発
righttouch
PRO
1
610
よくできたテンプレート言語として TypeScript + JSX を利用する試み / Using TypeScript + JSX outside of Web Frontend #TSKaigiKansai
izumin5210
6
1.7k
Jakarta EE meets AI
ivargrimstad
0
670
C++でシェーダを書く
fadis
6
4.1k
Featured
See All Featured
Done Done
chrislema
181
16k
A Tale of Four Properties
chriscoyier
156
23k
Practical Orchestrator
shlominoach
186
10k
Adopting Sorbet at Scale
ufuk
73
9.1k
4 Signs Your Business is Dying
shpigford
180
21k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
26
1.4k
How to Ace a Technical Interview
jacobian
276
23k
Building Your Own Lightsaber
phodgson
103
6.1k
What's in a price? How to price your products and services
michaelherold
243
12k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
48k
Producing Creativity
orderedlist
PRO
341
39k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
25
1.8k
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