はじめてでも怖くない！ Postman を使って、Web API を触ってみよう！ #hajimete_it

# Session Title

はじめてでも怖くない！ Postman を使って、Web API を触ってみよう！

# Event Info

#7 はじめてのIT勉強会 in 仙台(2019)：https://lets-go-study-meeting.connpass.com/event/148857/

2019/10/23（水）

# Sumally

Web APIを聞いたことがあるけれど、イマイチ一歩踏み出せない。触り始めるためにどうしたらいいのかわからない。そんな方に Postman というツールをきっかけにして踏み出してもらおうという趣旨です。

あまり Web APIとはなんぞや？　みたいなところには突っ込みすぎません。Web APIのドキュメントは見たことあるけれど、ここからどうしたらいいのかわからない、という感じの時に見るといいかもです。

# Blog Article

このセッションの内容は以下のBlog記事でも詳しく書いています。併せて参照してみてください。

Morning Girl：はじめてでも怖くない！Postman を使って、Web API を触ってみよう！
http://kageura.hatenadiary.jp/entry/hazimetepostman

# お試し用 Web API

今回のセッション向けにお試し用の手軽なWeb APIを公開しています。以下でドキュメントが見れます。

- URI：http://decodeapiserverdemo.azurewebsites.net/api.rst
- ID：user（ReadOnly）
- Password：3s3E4a4r7Q7d2a1J0i4l
- AuthType：Basic

この Web API そのものの作り方は以下のBlogで解説しています。

無料の API 自動生成ツールを使って、Excelファイルから REST API を生成してみる：CData API Server
http://kageura.hatenadiary.jp/entry/cdataapiserverexcel

Transcript

1. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   はじめてでも怖くない！
   Postman を使って、Web API を触ってみよう！
   2019/10/23
   #7 はじめてのIT勉強会 in 仙台(2019)
   CData Software Japan
   Kazuya Sugimoto -Lead Engineer
   

   View Slide

2. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   杉本 和也：Kazuya Sugimoto
   CData Software Japan, LLC Lead Engineer
   Microsoft MVP for Business Applications (Dynamics CRM/365)
   普段は仕事でも趣味でもひたすらWeb APIを触っているWeb API Horic
   今まで100種類くらいのサービスのWeb APIを見たり触ったりしてる（たぶん）
   Blog：Morning Girl
   http://kageura.hatenadiary.jp/
   Twitter：@sugimomoto Facebook：sugimomoto
   

   View Slide

3. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   Postman ってご存知ですか？
   Web API の開発者「提供する側・活用する側」双方にとってよりよい
   開発・検証のエクスペリエンスを提供するクライアントアプリケーション
   

   View Slide

4. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   Postman って素晴らしい！
   たくさん機能が提供されているのだけど
   とにかく API の検証・テスティングがとっても楽にできるのがいい！
   

   View Slide

5. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   そして世は Web API 戦国時代
   APIs show Faster Growth Rate in 2019 than Previous Years
   https://www.programmableweb.com/news/apis-show-faster-growth-rate-2019-previous-years/research/2019/07/17
   2012年
   TwitterがAPIを公開
   2012年から7年で
   約17,000 API も増加！
   

   View Slide

6. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   Web API はもはや必須の技術スキル！ でも・・・
   REST？
   なにそれ？
   やすむの？ 認証？
   OAuth？
   よくわからん！
   HTTP リクエスト？
   Query?
   URLパラメータ？
   JSONですら
   敷居が高いのに！
   

   View Slide

7. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   curl とかもよーわからん
   

   View Slide

8. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   今日のゴール
   はじめて Web API を触ってみようと言う方向け！
   Web API って聞いたことがあるけれど、
   「イマイチ一歩踏み出せない」
   「触り始めるためにどうしたらいいのかわからない」
   そんな方に Postman というツールをきっかけにして
   Web API に踏み出してもらう
   

   View Slide

9. © 2018 CData Software Japan, LLC | www.cdata.com/jp
   お試し用APIも公開中
   

   View Slide

10. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    これさえ押さえておけば怖くない
    REST APIを触るための７つの要素
    Base URI
    Web APIサービスの
    エンドポイント・ア
    ドレスを指定
    Resource
    操作したいデータは
    何かを指定
    Method
    どんな操作（取得・
    作成・削除・更新）
    を行うのかを指定
    Query
    データをどこまで・
    どれを取得したいの
    かを指定
    Header
    どんな仕様でデータ
    をやりとりしたいの
    かを指定
    Body
    どんなデータを登録
    や更新したいのかを
    指定
    Authentication
    誰がアクセスするの
    か、IDやパスワー
    ド・Tokenを指定
    

    View Slide

11. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    基本的にはすべてAPI仕様書に書かれている
    Base URI
    Resource
    Method
    Header
    Authentication
    Query
    

    View Slide

12. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    というわけで、Postmanで試してみよう
    O’Reilly Book List APIから
    データを 10件 JSONで取得する
    

    View Slide

13. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ① Base URI を入力する
    

    View Slide

14. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ② 対象のリソースを指定する
    OReillyBookList
    

    View Slide

15. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ③ Methodを決める
    今回はデータを取得するので GET
    

    View Slide

16. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ④ Params を選択して
    ⑤ Query を入力する
    今回は10件データを取得するので
    $top / 10 と入力する
    Queryを入力すると
    URIに自動的に追加される
    

    View Slide

17. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ⑥ Authorization を選択し
    て
    ⑦ Basic Auth Type を選択
    する
    ⑧ UsernameとPasswordを
    入力する
    

    View Slide

18. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ⑨ Headers を選択して
    ⑩ JSONデータが欲しいので
    Accept/ application/json を指定する
    

    View Slide

19. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    ⑪ Send をクリック
    ⑫ Web API を通じて
    JSON データが取得できた！
    

    View Slide

20. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    やった Web API からデータが取得できた！
    

    View Slide

21. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    でも、プログラミング言語からどうやったらいいの？
    

    View Slide

22. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    安心してください
    Postman には Code Snippets という
    素晴らしい機能があります！
    

    View Slide

23. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    Code をクリックします
    

    View Slide

24. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    各種プログラミング言語を
    選択できる！
    

    View Slide

25. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    C# で対象のAPIをどんな風にリクエ
    ストすればいいのかわかる！
    例えば C# を選択すると
    

    View Slide

26. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    是非素晴らしい Web API ライフを！
    

    View Slide

27. © 2018 CData Software Japan, LLC | www.cdata.com/jp
    本日の資料
    http://bit.ly/hazimetepostman
    

    View Slide