GitHub API

URL: https://developer.github.com

HTTP verbs¹

^{Where possible, API v3 strives to use appropriate HTTP verbs for each action.}

另外：

• OPTIONS: 查看可用请求方法

使用

requests.[method](url)

request method——GET

https://developer.github.com/v3/users/ 的用法：

import json
import requestsURL = 'https://api.github.com'def build_uri(endpoint):return '/'.join([URL, endpoint])def better_print(json_str):return json.dumps(json.loads(json_str), indent=4)def request_method():response = requests.get(build_uri('users/onefine'))print(better_print(response.text))if __name__ == '__main__':request_method()

输出：

{"login": "onefine","id": 15047276,"node_id": "MDQ6VXNlcjE1MDQ3Mjc2","avatar_url": "https://avatars1.githubusercontent.com/u/15047276?v=4","gravatar_id": "","url": "https://api.github.com/users/onefine","html_url": "https://github.com/onefine","followers_url": "https://api.github.com/users/onefine/followers","following_url": "https://api.github.com/users/onefine/following{/other_user}","gists_url": "https://api.github.com/users/onefine/gists{/gist_id}","starred_url": "https://api.github.com/users/onefine/starred{/owner}{/repo}","subscriptions_url": "https://api.github.com/users/onefine/subscriptions","organizations_url": "https://api.github.com/users/onefine/orgs","repos_url": "https://api.github.com/users/onefine/repos","events_url": "https://api.github.com/users/onefine/events{/privacy}","received_events_url": "https://api.github.com/users/onefine/received_events","type": "User","site_admin": false,"name": "onefine","company": null,"blog": "","location": null,"email": null,"hireable": null,"bio": null,"public_repos": 5,"public_gists": 0,"followers": 0,"following": 1,"created_at": "2015-10-09T09:10:16Z","updated_at": "2019-02-17T07:31:36Z"
}

更改：

def request_method():response = requests.get(build_uri('user/emails'), auth=('onefine', '******'))print(better_print(response.text))

结果：

[{"email": "188302531@qq.com","primary": true,"verified": true,"visibility": "public"}
]

带参数的请求：

1. URL Parameters: URL参数

• https://list.tmall.com/search_product.html?cat=50514037&...
• params: requests.get(url, params={'key1', 'value1'})

2. 表单参数提交

• Content-Type: application/x-www-form-urlencoded
• 内容： key1=value1&key2=value2
• requests.post(url, data={'key1': 'value1', 'key2': 'value2'})

3. json参数提交

• Content-Type: application/json
• 内容：’{“key1”: “value1”, “key2”: “value2”}’
• requests.post(url, json={'key1': 'value1', 'key2': 'value2'})

Get all users

Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

GET /users

Parameters

示例：

def params_request():response = requests.get(build_uri('users'), params={'since': 11})print(better_print(response.text))print(response.request.headers)print(response.url)if __name__ == '__main__':params_request()

输出：

[{"login": "vanpelt","id": 17,"node_id": "MDQ6VXNlcjE3","avatar_url": "https://avatars1.githubusercontent.com/u/17?v=4","gravatar_id": "","url": "https://api.github.com/users/vanpelt","html_url": "https://github.com/vanpelt","followers_url": "https://api.github.com/users/vanpelt/followers","following_url": "https://api.github.com/users/vanpelt/following{/other_user}","gists_url": "https://api.github.com/users/vanpelt/gists{/gist_id}","starred_url": "https://api.github.com/users/vanpelt/starred{/owner}{/repo}","subscriptions_url": "https://api.github.com/users/vanpelt/subscriptions","organizations_url": "https://api.github.com/users/vanpelt/orgs","repos_url": "https://api.github.com/users/vanpelt/repos","events_url": "https://api.github.com/users/vanpelt/events{/privacy}","received_events_url": "https://api.github.com/users/vanpelt/received_events","type": "User","site_admin": false},#　...省略{"login": "knzconnor","id": 53,"node_id": "MDQ6VXNlcjUz","avatar_url": "https://avatars3.githubusercontent.com/u/53?v=4","gravatar_id": "","url": "https://api.github.com/users/knzconnor","html_url": "https://github.com/knzconnor","followers_url": "https://api.github.com/users/knzconnor/followers","following_url": "https://api.github.com/users/knzconnor/following{/other_user}","gists_url": "https://api.github.com/users/knzconnor/gists{/gist_id}","starred_url": "https://api.github.com/users/knzconnor/starred{/owner}{/repo}","subscriptions_url": "https://api.github.com/users/knzconnor/subscriptions","organizations_url": "https://api.github.com/users/knzconnor/orgs","repos_url": "https://api.github.com/users/knzconnor/repos","events_url": "https://api.github.com/users/knzconnor/events{/privacy}","received_events_url": "https://api.github.com/users/knzconnor/received_events","type": "User","site_admin": false}
]
{'User-Agent': 'python-requests/2.21.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '*/*', 'Connection': 'keep-alive'}
https://api.github.com/users?since=11

Update the authenticated user

PATCH /user

Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

Parameters

def json_request():response = requests.patch(build_uri('user'), auth=('onefine', '******'),json={'name': 'onefine',# 'email': 'hello-world@onefine.com','blog': 'https://blog.csdn.net/jiduochou963',})print(better_print(response.text))print(response.request.headers)print(response.request.body)print(response.status_code)if __name__ == '__main__':json_request()

输出：

{"login": "onefine","id": 15047276,"node_id": "MDQ6VXNlcjE1MDQ3Mjc2","avatar_url": "https://avatars1.githubusercontent.com/u/15047276?v=4","gravatar_id": "","url": "https://api.github.com/users/onefine","html_url": "https://github.com/onefine","followers_url": "https://api.github.com/users/onefine/followers","following_url": "https://api.github.com/users/onefine/following{/other_user}","gists_url": "https://api.github.com/users/onefine/gists{/gist_id}","starred_url": "https://api.github.com/users/onefine/starred{/owner}{/repo}","subscriptions_url": "https://api.github.com/users/onefine/subscriptions","organizations_url": "https://api.github.com/users/onefine/orgs","repos_url": "https://api.github.com/users/onefine/repos","events_url": "https://api.github.com/users/onefine/events{/privacy}","received_events_url": "https://api.github.com/users/onefine/received_events","type": "User","site_admin": false,"name": "onefine","company": null,"blog": "https://blog.csdn.net/jiduochou963","location": null,"email": "188302531@qq.com","hireable": null,"bio": null,"public_repos": 5,"public_gists": 0,"followers": 0,"following": 1,"created_at": "2015-10-09T09:10:16Z","updated_at": "2019-02-23T06:44:38Z","private_gists": 0,"total_private_repos": 0,"owned_private_repos": 0,"disk_usage": 0,"collaborators": 0,"two_factor_authentication": false,"plan": {"name": "free","space": 976562499,"collaborators": 0,"private_repos": 10000}
}
{'User-Agent': 'python-requests/2.21.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '*/*', 'Connection': 'keep-alive', 'Content-Length': '65', 'Content-Type': 'application/json', 'Authorization': 'Basic b25lZmluZTpTaWxlbnQ5NjMxMjM='}
b'{"name": "onefine", "blog": "https://blog.csdn.net/jiduochou963"}'
200

添加email：

def json_request():response = requests.post(build_uri('user/emails'), auth=('onefine', '******'),json=['hello-world@onefine.com'])print(better_print(response.text))print(response.request.headers)print(response.request.body)print(response.status_code)if __name__ == '__main__':json_request()

输出：

[{"email": "188302531@qq.com","primary": true,"verified": true,"visibility": "public"},{"email": "hello-world@onefine.com","primary": false,"verified": false,"visibility": null}
]
{'User-Agent': 'python-requests/2.21.0', 'Accept-Encoding': 'gzip, deflate', 'Accept': '*/*', 'Connection': 'keep-alive', 'Content-Length': '27', 'Content-Type': 'application/json', 'Authorization': 'Basic b25lZmluZTpTaWxlbnQ5NjMxMjM='}
b'["hello-world@onefine.com"]'
201

Requests库-请求异常处理

from requests import exceptions

• exceptions.BaseHTTPError
• exceptions.ChunkedEncodingError
• exceptions.ConnectTimeout
• exceptions.ConnectionError
• exceptions.ContentDecodingError
• exceptions.HTTPError
• exceptions.InvalidHeader
• exceptions.InvalidURL
• exceptions.MissingSchema
• exceptions.ProxyError
• exceptions.ReadTimeout
• exceptions.RequestException
• exceptions.RetryError
• exceptions.SSLError
• exceptions.StreamConsumedError
• exceptions.Timeout
• exceptions.TooManyRedirects
• exceptions.URLRequired

超时为例：

requests.get(url, timeout=(3, 7))requests.get(url, timeout=10)

from requests import exceptionsdef timeout_request():try:response = requests.get(build_uri('user/emails'), timeout=0.1)except exceptions.Timeout as e:print("连接超时：", e)else:print(response.text)if __name__ == '__main__':timeout_request()

输出：

连接超时： HTTPSConnectionPool(host='api.github.com', port=443): Read timed out. (read timeout=0.1)

修改为正常时间：

from requests import exceptionsdef timeout_request():try:response = requests.get(build_uri('user/emails'), timeout=10)except exceptions.Timeout as e:print("连接超时：", e)else:print(response.text)print(response.status_code)if __name__ == '__main__':timeout_request()

输出：

{"message":"Requires authentication","documentation_url":"https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user"}
401

处理异常：

from requests import exceptionsdef timeout_request():try:response = requests.get(build_uri('user/emails'), timeout=10)# 显式抛出异常：response.raise_for_status()except exceptions.Timeout as e:print("连接超时：", e)except exceptions.HTTPError as e:print("HTTPError: ", e)else:print(response.text)print(response.status_code)if __name__ == '__main__':timeout_request()

输出：

HTTPError:  401 Client Error: Unauthorized for url: https://api.github.com/user/emails

庖丁解牛——自定义Request

读源码，认清复杂事务背后简单的原理。

def hard_requests():from requests import Request, Sessions = Session()headers = {'User-agent': 'fake1.3.4'}req = Request('GET', build_uri('user/emails'), auth=('onefine', 'Silent963123'), headers=headers)prepped = req.prepare()print(prepped.body)print(prepped.headers)if __name__ == '__main__':hard_requests()

输出：

None
{'User-agent': 'fake1.3.4', 'Authorization': 'Basic b25lZmluZTpTaWxlbnQ5NjMxMjM='}

接着：

def hard_requests():from requests import Request, Sessions = Session()headers = {'User-agent': 'fake1.3.4'}req = Request('GET', build_uri('user/emails'), auth=('onefine', 'Silent963123'), headers=headers)prepped = req.prepare()print(prepped.body)print(prepped.headers)resp = s.send(prepped, timeout=5)print(resp.status_code)print(resp.request.headers)print(resp.text)if __name__ == '__main__':hard_requests()

输出：

None
{'User-agent': 'fake1.3.4', 'Authorization': 'Basic b25lZmluZTpTaWxlbnQ5NjMxMjM='}
200
{'User-agent': 'fake1.3.4', 'Authorization': 'Basic b25lZmluZTpTaWxlbnQ5NjMxMjM='}
[{"email":"188302531@qq.com","primary":true,"verified":true,"visibility":"public"},{"email":"hello-world@onefine.com","primary":false,"verified":false,"visibility":null}]

参考：
python的扩展包requests的高级用法： https://www.cnblogs.com/guhao123/p/4054177.html

1. https://developer.github.com/v3/#http-verbs ↩︎

2. 有时候用于修改资源，当这并不符合RESTful规范，更好的方法是PATCH。 ↩︎