API相关基础

request返回列表

• 200 一切正常，返回为一个标准结果
• 301 重定向到一个已经修改了的域名结果去
• 401 服务认为你没有被授权，没有拿到一个正确的credentials （证书）来访问这个API
• 400 服务器认为是一个bad request，没有传送接口需要的request形式
• 403 你传送的信息是被禁止的 ，或者你没有权限查看
• 404 你访问的资源服务器没有查找到，资源被删除

import requests
requests.get会返回request类型的变量：
属性status_code表示request返回标签值

request = requests.get("http://api.open-notify.org/iss-now.json:)
status = request.status_code
print(status)

Output
404

在请求中增加参数,使用params 来赋值一个字典

dic = {"lat": 37.78,"lon":-122.41}
response = requests.get("http://api.open-notify.org/iss-pass.json",params = dic)
content = response.content
print(content)

import json
json库包含两个转换方法

• dumps 把python类型数据转换承string
• loads 把string类型数据转换成python类型

conan = ["xiaolan","huiyuan","guangyan"]
conan_string = json.dumps(conan)
print(type(conan_string))
conan_origin = json.loads(conan_string)
print(type(conan_origin))

output
<class 'str'>
<class 'list'>

.json()可以将取到的response转化为Python object,用例将mock_requests.Response型转化为了dict型

parameters = {"lat": 37.78, "lon": -122.41}
response = requests.get("http://api.open-notify.org/iss-pass.json", params=parameters)
json_data = response.json()
print(type(json_data))
print(json_data)
first_pass_duration = json_data["response"][0]["duration"]
print(first_pass_duration)

output
<class 'dict'>
{'message': 'success', 'response': [{'duration': 369, 'risetime': 1441456672}, {'duration': 626, 'risetime': 1441462284}, {'duration': 581, 'risetime': 1441468104}, {'duration': 482, 'risetime': 1441474000}, {'duration': 509, 'risetime': 1441479853}], 'request': {'latitude': 37.78, 'longitude': -122.41, 'datetime': 1441417753, 'altitude': 100, 'passes': 5}}
369

部分response中包含status code和data各种部分，这些信息可以通过.headers提取

print(response.headers)
print(type(response.headers))
content_type = response.headers["content-type"]
print(content_type)

output
{'date': 'Sat, 05 Sep 2015 01:49:13 GMT', 'connection': 'keep-alive', 'via': '1.1 vegur', 'server': 'gunicorn/19.3.0', 'content-type': 'application/json', 'content-length': '520'}
<class 'dict'>
application/json

一个从astros.json取值的例子

image.png

response = requests.get("http://api.open-notify.org/astros.json")
res = response.json()
in_space_count = res["number"]
print(in_space_count)

output
9

大部分requests是需要Authorization的，在请求中通常添加headers参数来传递授权信息
headers的格式通常为:

{"Authorization": "token 1f36137fbbe1602f779300dad26e4c1b7fbab631"}

headers = {"Authorization": "token 1f36137fbbe1602f779300dad26e4c1b7fbab631"}
response = requests.get("https://api.github.com/users/VikParuchuri/orgs",headers = headers)
orgs = response.json()
print(orgs)

Pagination
params中需要包含两个参数，page和per_page，page标注要显示第几页，per_page标注一页显示多少条内容，传送参数无论任何内容都需要参数params,无论是这次的pagination，或者是以后的time，具体代码如下

params = {"per_page": 50, "page": 2}
response = requests.get("https://api.github.com/users/VikParuchuri/starred", headers=headers, params=params)
page2_repos = response.json()
print(page2_repos)

output
[{'hooks_url': 'https://api.github.com/repos/snowplow/snowplow/hooks', 'git_url': 'git://github.com/snowplow/snowplow.git', 'watchers_count': 2183, 'homepage': 
...

POST

post请求中携带json变量，创建一个名为test的库在repos目录下如下

payload = {"name": "test"}
requests.post("https://api.github.com/user/repos", json=payload)

返回的response的参数status_code可以表示返回类型,其中header依旧是上文中的授权用户
下面创建名为learning-about-apis的库

payload = {"name":"learning-about-apis"}
response = requests.post("https://api.github.com/user/repos",json = payload,headers = headers)
status = response.status_code
print(status)

output
201

PATCH

给库打补丁，使用patch命令，这里需要注意的是post的url是一个上层目录，post之后将新建name:test即test的库目录，如post代码中内容就是新建了repos/learning-about-apis这个目录，而patch目录的操作url就是
https://api.github.com/repos/VikParuchuri/learning-about-apis，来修改learning-about-apis的描述，故patch的使用针对于已经存在的目录，目录位置一般都是url的最后文件名（basename），代码如下

payload = {"description": "Learning about requests!","name":"learning-about-apis"}
response = requests.patch("https://api.github.com/repos/VikParuchuri/learning-about-apis",json=payload,headers=headers)
status = response.status_code
print(status)

output
200

DELETE

删除一个目录不需要再带json参数传payload，只需直接删除想要删除的repos即可，下面代码就是删除learning-about-apis库，代码如下

response = requests.delete("https://api.github.com/repos/VikParuchuri/learning-about-apis",headers = headers)
status = response.status_code
print(status)

output
204