Requests

in  

PythonのRequests Libraryの使い方です。

Get

requests.getメソッドの利用例になります。

下記の例はGitHub API V3でリポジトリの一覧を取得するコードです。 APIの呼び出し結果は requests.textメソッドで取得しています。結果はJSONで返ってくるのでjson.dumpsで出力しています。

GitHub API V3の公式ドキュメントはこちらになります。

1
2
3
4
5
6
7
8
9
import requests
import json

# 各自のユーザー名を指定してください
user_name = 'Your User name'
request_url = 'https://api.github.com/users/{}/repos'.format(user_name)
response = requests.get(request_url)
return json.dumps(response.text)

Post

requests.postメソッドの利用例になります。

下記の例はGitHub API V3でリポジトリを生成するコードです。 認証情報は各自の環境に合わせて変数に設定してください。

GitHub API V3の公式ドキュメントはこちらになります。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import requests
import json

# LOGIN_NAME, TOKEは認証情報になります。
LOGIN_NAME = 'Your Login Name'
TOKEN = 'Your Token'
owner = 'Your Organization'
request_url = 'https://{}:{}@api.github.com'.format(LOGIN_NAME, TOKEN) \
 + '/orgs/{}/repos'.format(owner)

payload = {
    'name': 'hoge',
    'private': 'true'
}
response = requests.post(request_url, data=json.dumps(payload))

request.postメソッドに対してdataパラメータにはJSON形式で値を指定しています。

Patch

requests.patchメソッドの利用例になります。

下記の例はGitHub API V3でリポジトリの情報を更新するコードです。 すでにあるリポジトリに対してデフォルトのブランチを更新しています。 認証情報は各自の環境に合わせて変数に設定してください。

GitHub API V3の公式ドキュメントはこちらになります。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import requests
import json

# LOGIN_NAME, TOKEは認証情報になります。
LOGIN_NAME = 'Your Login Name'
TOKEN = 'Your Token'
owner = 'Your Organization'
repo_name = 'Your Repository Name'

request_url = 'https://{}:{}@api.github.com'.format(LOGIN_NAME, TOKEN) + '/repos/{}/{}'.format(owner, repo_name)
payload = {'default_branch': 'develop'}
response = requests.patch(request_url, data=json.dumps(payload))

request.patchメソッドに対してdataパラメータにはJSON形式で値を指定しています。


Share