{"id":991463,"date":"2024-12-27T08:28:46","date_gmt":"2024-12-27T00:28:46","guid":{"rendered":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/991463.html"},"modified":"2024-12-27T08:28:57","modified_gmt":"2024-12-27T00:28:57","slug":"python%e5%a6%82%e4%bd%95%e6%b5%8b%e8%af%95api%e6%8e%a5%e5%8f%a3","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/991463.html","title":{"rendered":"python\u5982\u4f55\u6d4b\u8bd5api\u63a5\u53e3"},"content":{"rendered":"

\"python\u5982\u4f55\u6d4b\u8bd5api\u63a5\u53e3\"<\/p>\n

Python\u6d4b\u8bd5API\u63a5\u53e3\u53ef\u4ee5\u901a\u8fc7\u4f7f\u7528requests\u5e93\u3001unittest\u6216pytest\u8fdb\u884c\u6d4b\u8bd5\u3001\u4f7f\u7528Mock\u5e93\u6a21\u62dfAPI\u54cd\u5e94\u3001\u4f7f\u7528Postman\u7b49\u5de5\u5177\u8fdb\u884c\u624b\u52a8\u6d4b\u8bd5<\/strong>\u3002Python\u4e3aAPI\u6d4b\u8bd5\u63d0\u4f9b\u4e86\u591a\u79cd\u7075\u6d3b\u7684\u65b9\u5f0f\uff0c\u4f7f\u5f00\u53d1\u8005\u80fd\u591f\u786e\u4fdd\u63a5\u53e3\u7684\u6b63\u786e\u6027\u548c\u7a33\u5b9a\u6027\u3002\u5728\u8fd9\u91cc\uff0c\u6211\u4eec\u5c06\u8be6\u7ec6\u4ecb\u7ecd\u5982\u4f55\u4f7f\u7528\u8fd9\u4e9b\u65b9\u6cd5\u8fdb\u884cAPI\u63a5\u53e3\u6d4b\u8bd5\u3002<\/p>\n<\/p>\n

\u4e00\u3001\u4f7f\u7528REQUESTS\u5e93\u8fdb\u884cAPI\u8bf7\u6c42<\/h3>\n<\/p>\n

Requests\u662f\u4e00\u4e2a\u7b80\u5355\u6613\u7528\u7684HTTP\u5e93\uff0c\u9002\u5408\u7528\u4e8e\u53d1\u9001HTTP\u8bf7\u6c42\u5e76\u63a5\u6536\u54cd\u5e94\u3002<\/p>\n<\/p>\n

1. \u5b89\u88c5Requests\u5e93<\/h4>\n<\/p>\n

\u9996\u5148\uff0c\u9700\u8981\u786e\u4fdd\u5b89\u88c5\u4e86Requests\u5e93\u3002\u53ef\u4ee5\u901a\u8fc7\u4ee5\u4e0b\u547d\u4ee4\u8fdb\u884c\u5b89\u88c5\uff1a<\/p>\n<\/p>\n

pip install requests<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u53d1\u9001GET\u8bf7\u6c42<\/h4>\n<\/p>\n
GET\u8bf7\u6c42\u7528\u4e8e\u4ece\u670d\u52a1\u5668\u83b7\u53d6\u6570\u636e\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u4f7f\u7528Requests\u53d1\u9001GET\u8bf7\u6c42\u7684\u793a\u4f8b\uff1a<\/p>\n<\/p>\n
import requests<\/p>\n
response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
print(response.status_code)<\/p>\n
print(response.json())<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u5728\u8fd9\u4e2a\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u5411\u6307\u5b9a\u7684API\u7aef\u70b9\u53d1\u9001\u4e86\u4e00\u4e2aGET\u8bf7\u6c42\uff0c\u5e76\u6253\u5370\u4e86\u54cd\u5e94\u7684\u72b6\u6001\u7801\u548cJSON\u6570\u636e\u3002<\/p>\n<\/p>\n
3. \u53d1\u9001POST\u8bf7\u6c42<\/h4>\n<\/p>\n
POST\u8bf7\u6c42\u7528\u4e8e\u5411\u670d\u52a1\u5668\u53d1\u9001\u6570\u636e\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u53d1\u9001POST\u8bf7\u6c42\u7684\u793a\u4f8b\uff1a<\/p>\n<\/p>\n
import requests<\/p>\n
data = {'key1': 'value1', 'key2': 'value2'}<\/p>\n
response = requests.post('https:\/\/api.example.com\/data', json=data)<\/p>\n
print(response.status_code)<\/p>\n
print(response.json())<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u5728\u8fd9\u91cc\uff0c\u6211\u4eec\u901a\u8fc7POST\u8bf7\u6c42\u5c06\u6570\u636e\u53d1\u9001\u5230\u670d\u52a1\u5668\uff0c\u5e76\u6253\u5370\u4e86\u54cd\u5e94\u3002<\/p>\n<\/p>\n
\u4e8c\u3001\u4f7f\u7528UNITTEST\u6846\u67b6\u8fdb\u884c\u6d4b\u8bd5<\/h3>\n<\/p>\n
Unittest\u662fPython\u7684\u6807\u51c6\u5355\u5143\u6d4b\u8bd5\u6846\u67b6\uff0c\u9002\u5408\u7528\u4e8e\u81ea\u52a8\u5316\u6d4b\u8bd5\u3002<\/p>\n<\/p>\n
1. \u521b\u5efa\u6d4b\u8bd5\u7c7b<\/h4>\n<\/p>\n
\u4f7f\u7528Unittest\u521b\u5efa\u4e00\u4e2a\u6d4b\u8bd5\u7c7b\u6765\u7ec4\u7ec7\u6d4b\u8bd5\u7528\u4f8b\uff1a<\/p>\n<\/p>\n
import unittest<\/p>\n
import requests<\/p>\n
class TestAPI(unittest.TestCase):<\/p>\n
    def test_get_request(self):<\/p>\n
        response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
        self.assertEqual(response.status_code, 200)<\/p>\n
        self.assertIn('expected_key', response.json())<\/p>\n
    def test_post_request(self):<\/p>\n
        data = {'key1': 'value1'}<\/p>\n
        response = requests.post('https:\/\/api.example.com\/data', json=data)<\/p>\n
        self.assertEqual(response.status_code, 201)<\/p>\n
        self.assertIn('success', response.json())<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u8fd0\u884c\u6d4b\u8bd5<\/h4>\n<\/p>\n
\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u8fd0\u884c\u6d4b\u8bd5\uff1a<\/p>\n<\/p>\n
python -m unittest test_module.py<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u4e09\u3001\u4f7f\u7528PYTEST\u6846\u67b6\u8fdb\u884c\u6d4b\u8bd5<\/h3>\n<\/p>\n
Pytest\u662f\u4e00\u4e2a\u529f\u80fd\u5f3a\u5927\u3001\u7075\u6d3b\u7684\u6d4b\u8bd5\u6846\u67b6\uff0c\u652f\u6301\u66f4\u590d\u6742\u7684\u6d4b\u8bd5\u9700\u6c42\u3002<\/p>\n<\/p>\n
1. \u521b\u5efa\u6d4b\u8bd5\u51fd\u6570<\/h4>\n<\/p>\n
\u4f7f\u7528Pytest\u521b\u5efa\u7b80\u5355\u7684\u6d4b\u8bd5\u51fd\u6570\uff1a<\/p>\n<\/p>\n
import requests<\/p>\n
def test_get_request():<\/p>\n
    response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
    assert response.status_code == 200<\/p>\n
    assert 'expected_key' in response.json()<\/p>\n
def test_post_request():<\/p>\n
    data = {'key1': 'value1'}<\/p>\n
    response = requests.post('https:\/\/api.example.com\/data', json=data)<\/p>\n
    assert response.status_code == 201<\/p>\n
    assert 'success' in response.json()<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u8fd0\u884c\u6d4b\u8bd5<\/h4>\n<\/p>\n
\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u8fd0\u884c\u6d4b\u8bd5\uff1a<\/p>\n<\/p>\n
pytest test_file.py<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u56db\u3001\u4f7f\u7528MOCK\u5e93\u6a21\u62dfAPI\u54cd\u5e94<\/h3>\n<\/p>\n
Mock\u5e93\u53ef\u4ee5\u7528\u4e8e\u6a21\u62dfAPI\u54cd\u5e94\uff0c\u5e2e\u52a9\u8fdb\u884c\u66f4\u5168\u9762\u7684\u6d4b\u8bd5\u3002<\/p>\n<\/p>\n
1. \u5b89\u88c5Mock\u5e93<\/h4>\n<\/p>\n
Mock\u662funittest\u7684\u4e00\u4e2a\u6269\u5c55\u5e93\uff0c\u53ef\u4ee5\u901a\u8fc7\u4ee5\u4e0b\u547d\u4ee4\u5b89\u88c5\uff1a<\/p>\n<\/p>\n
pip install mock<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u6a21\u62dfAPI\u54cd\u5e94<\/h4>\n<\/p>\n
\u901a\u8fc7Mock\u5e93\u6a21\u62dfAPI\u54cd\u5e94\uff1a<\/p>\n<\/p>\n
from unittest.mock import patch<\/p>\n
import requests<\/p>\n
@patch('requests.get')<\/p>\n
def test_mocked_get_request(mock_get):<\/p>\n
    mock_get.return_value.status_code = 200<\/p>\n
    mock_get.return_value.json.return_value = {'key': 'value'}<\/p>\n
    response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
    assert response.status_code == 200<\/p>\n
    assert response.json() == {'key': 'value'}<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u4e94\u3001\u4f7f\u7528POSTMAN\u8fdb\u884c\u624b\u52a8\u6d4b\u8bd5<\/h3>\n<\/p>\n
Postman\u662f\u4e00\u4e2a\u6d41\u884c\u7684API\u5f00\u53d1\u5de5\u5177\uff0c\u652f\u6301\u624b\u52a8\u6d4b\u8bd5API\u8bf7\u6c42\u3002<\/p>\n<\/p>\n
1. \u521b\u5efa\u8bf7\u6c42<\/h4>\n<\/p>\n
\u5728Postman\u4e2d\u521b\u5efa\u4e00\u4e2a\u65b0\u7684\u8bf7\u6c42\uff0c\u9009\u62e9\u8bf7\u6c42\u7c7b\u578b\uff08GET\u3001POST\u7b49\uff09\uff0c\u5e76\u8f93\u5165URL\u3002<\/p>\n<\/p>\n
2. \u914d\u7f6e\u8bf7\u6c42\u53c2\u6570<\/h4>\n<\/p>\n
\u6839\u636eAPI\u6587\u6863\uff0c\u914d\u7f6e\u8bf7\u6c42\u7684\u53c2\u6570\u3001\u5934\u4fe1\u606f\u548c\u8bf7\u6c42\u4f53\u3002<\/p>\n<\/p>\n
3. \u53d1\u9001\u8bf7\u6c42\u5e76\u68c0\u67e5\u54cd\u5e94<\/h4>\n<\/p>\n
\u70b9\u51fb\u201cSend\u201d\u6309\u94ae\u53d1\u9001\u8bf7\u6c42\uff0c\u68c0\u67e5\u54cd\u5e94\u72b6\u6001\u7801\u548c\u6570\u636e\u3002<\/p>\n<\/p>\n
\u516d\u3001\u603b\u7ed3<\/h3>\n<\/p>\n
Python\u63d0\u4f9b\u4e86\u591a\u79cd\u65b9\u5f0f\u6765\u6d4b\u8bd5API\u63a5\u53e3\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u6839\u636e\u9700\u6c42\u9009\u62e9\u9002\u5408\u7684\u5de5\u5177\u548c\u6846\u67b6\u3002\u901a\u8fc7\u4f7f\u7528Requests\u5e93\u53d1\u9001\u8bf7\u6c42\u3001\u5229\u7528Unittest\u548cPytest\u8fdb\u884c\u81ea\u52a8\u5316\u6d4b\u8bd5\u3001\u4f7f\u7528Mock\u5e93\u6a21\u62df\u54cd\u5e94\u4ee5\u53ca\u4f7f\u7528Postman\u8fdb\u884c\u624b\u52a8\u6d4b\u8bd5\uff0c\u80fd\u591f\u5168\u9762\u5730\u9a8c\u8bc1API\u63a5\u53e3\u7684\u529f\u80fd\u548c\u6027\u80fd\u3002\u8fd9\u4e9b\u65b9\u6cd5\u76f8\u8f85\u76f8\u6210\uff0c\u5e2e\u52a9\u5f00\u53d1\u8005\u63d0\u9ad8API\u5f00\u53d1\u548c\u6d4b\u8bd5\u7684\u6548\u7387\uff0c\u786e\u4fddAPI\u63a5\u53e3\u7684\u9ad8\u8d28\u91cf\u3002<\/p>\n<\/p>\n
\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n
 \u5982\u4f55\u4f7f\u7528Python\u8fdb\u884cAPI\u63a5\u53e3\u6d4b\u8bd5\uff1f<\/strong>
\u4f7f\u7528Python\u8fdb\u884cAPI\u63a5\u53e3\u6d4b\u8bd5\u53ef\u4ee5\u901a\u8fc7\u591a\u79cd\u5e93\u6765\u5b9e\u73b0\uff0c\u6700\u5e38\u7528\u7684\u6709requests<\/code>\u548cunittest<\/code>\u3002requests<\/code>\u5e93\u80fd\u591f\u65b9\u4fbf\u5730\u53d1\u9001HTTP\u8bf7\u6c42\uff0c\u800cunittest<\/code>\u5219\u63d0\u4f9b\u4e86\u6d4b\u8bd5\u6846\u67b6\u3002\u9996\u5148\uff0c\u4f7f\u7528requests<\/code>\u53d1\u9001\u8bf7\u6c42\uff0c\u63a5\u7740\u901a\u8fc7\u65ad\u8a00\u6765\u9a8c\u8bc1\u54cd\u5e94\u7684\u72b6\u6001\u7801\u3001\u5185\u5bb9\u548c\u683c\u5f0f\u7b49\u3002<\/p>\n
\u6211\u5e94\u8be5\u4f7f\u7528\u54ea\u4e9bPython\u5e93\u6765\u6d4b\u8bd5API\u63a5\u53e3\uff1f<\/strong>
\u5728\u8fdb\u884cAPI\u63a5\u53e3\u6d4b\u8bd5\u65f6\uff0c\u53ef\u4ee5\u8003\u8651\u4f7f\u7528\u4ee5\u4e0b\u5e93\uff1a  <\/p>\n
    \n
  1. requests<\/code>\uff1a\u7528\u4e8e\u53d1\u9001HTTP\u8bf7\u6c42\u5e76\u83b7\u53d6\u54cd\u5e94\u3002  <\/li>\n
  2. unittest<\/code>\uff1aPython\u5185\u7f6e\u7684\u6d4b\u8bd5\u6846\u67b6\uff0c\u9002\u5408\u7f16\u5199\u6d4b\u8bd5\u7528\u4f8b\u3002  <\/li>\n
  3. pytest<\/code>\uff1a\u4e00\u4e2a\u529f\u80fd\u5f3a\u5927\u7684\u6d4b\u8bd5\u6846\u67b6\uff0c\u652f\u6301\u66f4\u591a\u7684\u6d4b\u8bd5\u529f\u80fd\u548c\u63d2\u4ef6\u3002  <\/li>\n
  4. responses<\/code>\uff1a\u7528\u4e8e\u6a21\u62dfHTTP\u54cd\u5e94\uff0c\u65b9\u4fbf\u6d4b\u8bd5\u4e0d\u4f9d\u8d56\u4e8e\u5916\u90e8API\u3002  <\/li>\n
  5. Postman<\/code>\u548cNewman<\/code>\uff1a\u867d\u7136\u4e0d\u662fPython\u5e93\uff0c\u4f46\u53ef\u4ee5\u4e0ePython\u7ed3\u5408\u4f7f\u7528\u8fdb\u884cAPI\u6d4b\u8bd5\u3002<\/li>\n<\/ol>\n
    \u5982\u4f55\u786e\u4fdd\u6211\u7684API\u6d4b\u8bd5\u8986\u76d6\u6240\u6709\u529f\u80fd\uff1f<\/strong>
    \u4e3a\u4e86\u786e\u4fddAPI\u6d4b\u8bd5\u8986\u76d6\u6240\u6709\u529f\u80fd\uff0c\u5efa\u8bae\u91c7\u53d6\u4ee5\u4e0b\u63aa\u65bd\uff1a  <\/p>\n
      \n
    1. \u7f16\u5199\u5168\u9762\u7684\u6d4b\u8bd5\u7528\u4f8b\uff0c\u6db5\u76d6\u6240\u6709API\u7aef\u70b9\u3002  <\/li>\n
    2. \u6d4b\u8bd5\u4e0d\u540c\u7684\u8f93\u5165\u53c2\u6570\uff0c\u5305\u62ec\u6709\u6548\u548c\u65e0\u6548\u7684\u503c\u3002  <\/li>\n
    3. \u9a8c\u8bc1\u54cd\u5e94\u7684\u72b6\u6001\u7801\u3001\u5934\u4fe1\u606f\u548c\u5185\u5bb9\u3002  <\/li>\n
    4. \u4f7f\u7528\u81ea\u52a8\u5316\u6d4b\u8bd5\u5de5\u5177\u5b9a\u671f\u8fd0\u884c\u6d4b\u8bd5\u7528\u4f8b\uff0c\u786e\u4fdd\u65b0\u4ee3\u7801\u7684\u5f15\u5165\u4e0d\u4f1a\u7834\u574f\u73b0\u6709\u529f\u80fd\u3002  <\/li>\n
    5. \u8003\u8651\u4f7f\u7528API\u6587\u6863\u4f5c\u4e3a\u6d4b\u8bd5\u7528\u4f8b\u7684\u57fa\u7840\uff0c\u786e\u4fdd\u6bcf\u4e2a\u529f\u80fd\u90fd\u5f97\u5230\u9a8c\u8bc1\u3002<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"Python\u6d4b\u8bd5API\u63a5\u53e3\u53ef\u4ee5\u901a\u8fc7\u4f7f\u7528requests\u5e93\u3001unittest\u6216pytest\u8fdb\u884c\u6d4b\u8bd5\u3001\u4f7f\u7528Mock […]","protected":false},"author":3,"featured_media":991481,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/991463"}],"collection":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=991463"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/991463\/revisions"}],"predecessor-version":[{"id":991482,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/991463\/revisions\/991482"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/991481"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=991463"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=991463"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=991463"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}