02.接口请求方法

目录

 

• 常见 HTTP 请求方法构造
• 演练环境
• HTTP 协议知识回顾
• 构造请求方法

常见 HTTP 请求方法构造

 

方法	说明
requests.request()	构造一个请求，支撑以下各方法的基础方法。
requests.get()	构造 HTTP 协议中的 GET 请求。
requests.post()	构造 HTTP 协议中的 POST 请求。
requests.put()	构造 HTTP 协议中的 PUT 请求。
requests.delete()	构造 HTTP 协议中的 DELETE 请求。

底层设计

 

@startuml
scale 10
frame "requests.get()" as get
frame "requests.post()" as post
frame "requests.put()" as put
frame "requests.delete()" as delete
frame  "requests.request()" as request

get --> request: 调用
post --> request: 调用
put --> request: 调用
delete --> request: 调用

@enduml

演练环境

 

• https://httpbin.ceshiren.com/

HTTP 协议知识回顾

 

• URL 结构
• HTTP 请求
• HTTP 响应

具体详见《常见接口协议》录播

构造 GET 请求

 

• requests.get(url, params=None, **kwargs)
  • url: 接口 url。
  • params：拼接在 url 中的请求参数。
  • **kwargs：更多底层支持的参数。

# 导入依赖
import requests

def test_get():
    # 定义接口的 url 和拼接在 url 中的请求参数
    url = "https://httpbin.ceshiren.com/get"
    # 发出 GET 请求，r 接收接口响应
    r = requests.get(url)
    # 打印接口响应
    logger.info(f"接口响应为 {r}")

构造 POST 请求

 

• requests.post(url, data=None, json=None, **kwargs)
  • url: 接口 url。
  • data：表单格式请求体。
  • json：JSON 格式请求体。
  • **kwargs：更多底层支持的参数。

# 导入依赖
import requests

def test_post():
    # 定义接口的 url
    url = "https://httpbin.ceshiren.com/post"
    # 发出 POST 请求，r 接收接口响应
    r = requests.post(url)
    # 打印接口响应
    logger.info(f"接口响应为 {r}")

构造 PUT 请求

 

• requests.put(url, data=None, **kwargs)
  • url: 接口 url。
  • data：表单格式请求体。
  • **kwargs：更多底层支持的参数。

# 导入依赖
import requests

def test_put():
    # 定义接口的 url
    url = "https://httpbin.ceshiren.com/put"
    # 发出 POST 请求，r 接收接口响应
    r = requests.put(url)
    # 打印接口响应
    logger.info(f"接口响应为 {r}")

构造 DELETE 请求

 

• requests.delete(url, **kwargs)
  • url: 接口 url。
  • **kwargs：更多底层支持的参数。

# 导入依赖
import requests

def test_delete():
    # 定义接口的 url 和表单格式请求体
    url = "https://httpbin.ceshiren.com/delete"
    # 发出 POST 请求，r 接收接口响应
    r = requests.delete(url)
    # 打印接口响应
    logger.info(f"接口响应为 {r}")

构造请求方法

 

• requests.request(method, url, **kwargs)
  • method: 请求方法。
    • GET，OPTIONS，HEAD，POST，PUT，PATCH，DELETE。
  • url: 接口 url。
  • **kwargs：更多底层支持的参数。

def request(method, url, **kwargs):
    """Constructs and sends a :class:`Request <Request>`.

    :param method: method for the new :class:`Request` object: ``GET``, ``OPTIONS``, ``HEAD``, ``POST``, ``PUT``, ``PATCH``, or ``DELETE``.
    :param url: URL for the new :class:`Request` object.
    :param params: (optional) Dictionary, list of tuples or bytes to send
        in the query string for the :class:`Request`.
    :param data: (optional) Dictionary, list of tuples, bytes, or file-like
        object to send in the body of the :class:`Request`.
    :param json: (optional) A JSON serializable Python object to send in the body of the :class:`Request`.
    :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
    :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`.
    :param files: (optional) Dictionary of ``'name': file-like-objects`` (or ``{'name': file-tuple}``) for multipart encoding upload.
        ``file-tuple`` can be a 2-tuple ``('filename', fileobj)``, 3-tuple ``('filename', fileobj, 'content_type')``
        or a 4-tuple ``('filename', fileobj, 'content_type', custom_headers)``, where ``'content-type'`` is a string
        defining the content type of the given file and ``custom_headers`` a dict-like object containing additional headers
        to add for the file.
    :param auth: (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
    :param timeout: (optional) How many seconds to wait for the server to send data
        before giving up, as a float, or a :ref:`(connect timeout, read
        timeout) <timeouts>` tuple.
    :type timeout: float or tuple
    :param allow_redirects: (optional) Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to ``True``.
    :type allow_redirects: bool
    :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy.
    :param verify: (optional) Either a boolean, in which case it controls whether we verify
            the server's TLS certificate, or a string, in which case it must be a path
            to a CA bundle to use. Defaults to ``True``.
    :param stream: (optional) if ``False``, the response content will be immediately downloaded.
    :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair.
    :return: :class:`Response <Response>` object
    :rtype: requests.Response

底层参数说明

 

参数	应用场景
method	请求方法
url	请求 URL
params	请求中携带 URL 参数
data	请求中携带请求体（默认为表单请求）
json	请求中携带 json 格式的请求体
headers	请求中携带头信息
cookies	请求中携带 cookies
files	请求中携带文件格式的请求体
auth	请求中携带认证信息
timeout	设置请求超时时间
allow_redirects	请求是否允许重定向
proxies	设置请求代理
verify	请求是否要认证
cert	请求中携带 ssl 证书