つ・な・が・り・た・い REST_APIのお話

つ・な・が・り・た・い 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

(ちゃんと学んだ) 今の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)

ステートレスで、リクエストごとに独立している 19

ステートレスで、リクエストごとに独立している 20 GETメソッドは、常に同じ値を返却する。(リソース更新が入らない限り) PUTメソッドは、常に同じ値を登録し続ける。トランザクションを提供できないので、トランザクションが必要な単位でなるべく細かいAPIにすることが大事。

その他 21

REST APIに向いているサービス 22

REST APIに向いているサービス 23 ▰ HTTPメソッドで操作しきれないサービス ▰ 例) DropboxはRESTからRPCの提供に変更 ▰
複数のリソースに対してアクセスするAPI ▰ 例) ユーザの投稿、写真、ユーザの友達の写真等々の facebook, instagram等で試用されているGraphQL。

おわり 24

APPENDIX 25

参考ページ 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

つ・な・が・り・た・い REST_APIのお話

つ・な・が・り・た・い REST_APIのお話

kirimaru

More Decks by kirimaru

Other Decks in Programming

Featured

Transcript