• Skip to main content
  • Skip to primary sidebar
  • ホーム
  • お問い合わせ

ハイパー仕事し隊

思い立った吉日!イロイロ試してオンリーワンの起業家を目指してます!

現在の場所:ホーム / ウェブアプリ関連 / Postman と requests (Python モジュール) で JSON レスポンスを確認する

Postman と requests (Python モジュール) で JSON レスポンスを確認する

2018年11月29日

アプリ開発では避けては通れない道。

JSON レスポンスの取り扱い。

本記事では Web API にどういうリクエストを出せば、どういうレスポンスが返ってくるかをサクッと確認する方法 ご紹介していきます。

追記:
VS Code を使っている方は、Rest Client がオススメです。
記事を書いていますので、ご確認ください
>>【VS Code プラグイン】Postman より便利!? Rest Client をオススメする理由

コンテンツ内容

  • 1 利用するエンドポイント
  • 2 Postman を使ってみる
    • 2.1 Chrome Extension をインストール
    • 2.2 EXE でローカルインストール
    • 2.3 GET リクエストをする
    • 2.4 その他の使い方
  • 3 Python の requests モジュールを使ってみる
  • 4 まとめ

利用するエンドポイント

一般的に API を利用する場合、アクセス数を確認し制限するため、そのサービスにユーザー登録する必要があります。

ですが、それでは「ツールの確認」とは別のところで結構時間が取られますの。

ありがたいことに、ユーザー登録不要でテスト用の API を提供しているサイトがあるので、そちらを利用させてもらいます。

こちらがそのサイトで、各種ダミーデータが取得できます。

  • Posts (https://jsonplaceholder.typicode.com/posts/)
  • Comments (https://jsonplaceholder.typicode.com/comments/)
  • Albums (https://jsonplaceholder.typicode.com/albums/)
  • Photos (https://jsonplaceholder.typicode.com/photos/)
  • Users (https://jsonplaceholder.typicode.com/users/)
  • Todos (https://jsonplaceholder.typicode.com/todos/)

メインで「Users (https://jsonplaceholder.typicode.com/users/)」を使いますが、他のページも必要に応じて使ってみてください。

Postman を使ってみる

Postman は、API の開発でよく利用されています。

どういうリクエストを出せば、どういうレスポンスがくるかが簡単にわかるので、始めて試す API の動作を見るの大変便利です。

個人的には、Postman で API 動作を理解 → Python で実装という流れでよく利用しています。

Chrome Extension をインストール

postman chrome

こちらからインストールできます。

Postman

Postman の公式サイトから提供されており、利用ユーザも多く評価も高いので安心して使えますね。

EXE でローカルインストール

Postman EXE

公式サイト(https://www.getpostman.com/)

特に複雑な設定はないので、OK で進んでいって問題ありません。

問題なくインストールできましたでしょうか?

それでは実際に、使っていきましょ!

GET リクエストをする

使い方はとてもシンプルで、ベーシックなポイントは 3 つ!

  • 「GET」を選択し
  • 「URL」 を入力し
  • 「Send」する

だけです。

そして、レスポンス結果が下側に表示されます。

また、フォルダごとにリクエスト方法を管理できるのですごい便利です。

この結果から、最初の情報の経度(lat) や緯度(lng)を取得する場合、

  • latitude = response[0][‘address’][‘geo’][‘lat’]
  • longitude = response[0][‘address’][‘geo’][‘lng’]

と階層を辿れば簡単にわかりますね。

その他の使い方

その他にもイロイロな使い方ができますので、ぜひ使ってみてください。

既にたくさんの方が詳しい使い方を載せていますので、こちらでは割愛します。

APIの開発がむちゃくちゃ捗る「Postman」の使い方

Python の requests モジュールを使ってみる

Python の標準ライブラリに urllib があるのですが、公式ページで Requests パッケージが推奨されています。

参考: URL を開くための拡張可能なライブラリ

なので、特に理由がなければ Requests パッケージを利用しましょ。

pip install requests

このようにしてダウンロードできます。

import requests

url = 'https://jsonplaceholder.typicode.com/users/'
res = requests.get(url)

res.status_code
json_res = res.json()

latitude = json_res[0]['address']['geo']['lat']
longitude = json_res[0]['address']['geo']['lng']

print(res.status_code) # 200
print(latitude) # -37.3159
print(longitude) # 81.1496

urllib を使うとエンコードなど面倒な作業がひつようなのですが、requests はなかなか簡単に利用できます。

利用する際は、import するの忘れないでくださいね!

まとめ

いかがでしたでしょうか?

JSON ファイルがどんな内容なのかを Postman で確認し、その後 Python で実装したら便利であることがわかりましたでしょうか?

実際には、GET リクエストにクエリを記述したり、Web API の認証などもあるのでそれらをまずは「見て分かる」ようにするのは大変重要かと思います。

これで Postman を使いこなせるようになり、Python で爆速なウェブ開発ができますね!

カテゴリー: ウェブアプリ関連
タグ: python

最初のサイドバー

簡単な自己紹介

ごく普通の 30 代サラリーマンです。世界を旅しながらの生活が目標!!
IT 全般に興味あり: Python (Flask, Django) / PHP (Laravel, Wordpress) / Golang / AWS / Network Security.
Read More…

サイト内検索

最近の投稿

  • 【VS Code プラグイン】Postman より便利!? Rest Client をオススメする理由
  • MySQL と phpMyAdmin を Docker Compose で作って、Python から接続する
  • Windows10 上の Ubuntu から “curl localhost” を実行すると “Connection refused” になる原因
  • リダイレクトの仕組み知ってる?Flask で調べるてみるのだ。
  • Apple 独自の 検索エンジンで何が変わるのか

アーカイブ

  • 2021年3月
  • 2021年1月
  • 2020年10月
  • 2019年3月
  • 2018年11月
  • 2018年10月
  • 2018年9月
  • 2018年8月
  • 2018年7月
  • 2018年5月
  • 2018年4月

タグ

amazon cloudfront amazon s3 aws coursera css django docker flask fullstack gcp github hawaii life in USA linux mongodb mysql postgresql pwa python sqlite vagrant

Contact
Privacy Policy and Term of Use
Copyright © 2023 · All rights reserved.