{"id":934204,"date":"2024-12-26T18:31:09","date_gmt":"2024-12-26T10:31:09","guid":{"rendered":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/934204.html"},"modified":"2024-12-26T18:31:12","modified_gmt":"2024-12-26T10:31:12","slug":"python%e5%a6%82%e4%bd%95%e4%bd%bf%e7%94%a8api","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/934204.html","title":{"rendered":"python\u5982\u4f55\u4f7f\u7528api"},"content":{"rendered":"

\"python\u5982\u4f55\u4f7f\u7528api\"<\/p>\n

Python\u4f7f\u7528API\u7684\u65b9\u5f0f\u4e3b\u8981\u6709\uff1a\u901a\u8fc7HTTP\u8bf7\u6c42\u5e93\uff08\u5982requests\uff09\u8fdb\u884cAPI\u8c03\u7528\u3001\u4f7f\u7528API\u63d0\u4f9b\u7684Python SDK\u3001\u5229\u7528\u7b2c\u4e09\u65b9\u5e93\u5c01\u88c5API\u7b49\u3002\u4e0b\u9762\u6211\u5c06\u8be6\u7ec6\u4ecb\u7ecd\u5982\u4f55\u4f7f\u7528requests\u5e93\u6765\u8c03\u7528API\u3002<\/p>\n<\/p>\n

\u901a\u8fc7HTTP\u8bf7\u6c42\u5e93\u5982requests\u8fdb\u884cAPI\u8c03\u7528\u3001\u4f7f\u7528API\u63d0\u4f9b\u7684Python SDK\u3001\u5229\u7528\u7b2c\u4e09\u65b9\u5e93\u5c01\u88c5API<\/strong>\uff0c\u8fd9\u4e9b\u65b9\u6cd5\u90fd\u80fd\u6709\u6548\u5730\u5e2e\u52a9\u5f00\u53d1\u8005\u4e0eAPI\u8fdb\u884c\u4ea4\u4e92\u3002\u5728\u4f7f\u7528requests\u5e93\u8fdb\u884cAPI\u8c03\u7528\u65f6\uff0c\u9996\u5148\u9700\u8981\u7406\u89e3HTTP\u8bf7\u6c42\u7684\u57fa\u672c\u6982\u5ff5\uff0c\u5982GET\u3001POST\u8bf7\u6c42\u3002\u63a5\u4e0b\u6765\uff0c\u6211\u5c06\u8be6\u7ec6\u63cf\u8ff0\u5982\u4f55\u4f7f\u7528requests\u5e93\u8fdb\u884cGET\u8bf7\u6c42\u3002<\/p>\n<\/p>\n

\u4e00\u3001HTTP\u8bf7\u6c42\u57fa\u7840<\/h3>\n<\/p>\n

\u5728\u4f7f\u7528API\u65f6\uff0c\u7406\u89e3HTTP\u8bf7\u6c42\u7684\u57fa\u7840\u77e5\u8bc6\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002HTTP\u8bf7\u6c42\u5305\u62ec\u65b9\u6cd5\u3001URL\u3001\u5934\u4fe1\u606f\u3001\u8bf7\u6c42\u4f53\u7b49\u8981\u7d20\u3002<\/p>\n<\/p>\n

    \n
  1. \n

    GET\u8bf7\u6c42<\/strong><\/p>\n<\/p>\n

    GET\u8bf7\u6c42\u662f\u6700\u5e38\u89c1\u7684HTTP\u8bf7\u6c42\u7c7b\u578b\uff0c\u7528\u4e8e\u4ece\u670d\u52a1\u5668\u83b7\u53d6\u6570\u636e\u3002\u5728Python\u4e2d\uff0c\u4f7f\u7528requests\u5e93\u53ef\u4ee5\u975e\u5e38\u65b9\u4fbf\u5730\u53d1\u8d77GET\u8bf7\u6c42\u3002<\/p>\n<\/p>\n

    import requests<\/p>\n
    response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
    print(response.status_code)  # \u6253\u5370\u72b6\u6001\u7801<\/p>\n
    print(response.json())       # \u6253\u5370\u8fd4\u56de\u7684JSON\u6570\u636e<\/p>\n
    <\/code><\/pre>\n<\/p>\n
    \u4e0a\u9762\u7684\u4ee3\u7801\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528requests.get()<\/code>\u65b9\u6cd5\u53d1\u9001\u4e86\u4e00\u4e2aGET\u8bf7\u6c42\u5230\u6307\u5b9a\u7684URL\u3002response.status_code<\/code>\u7528\u4e8e\u68c0\u67e5\u8bf7\u6c42\u662f\u5426\u6210\u529f\uff08\u901a\u5e38200\u8868\u793a\u6210\u529f\uff09\uff0cresponse.json()<\/code>\u7528\u4e8e\u89e3\u6790\u8fd4\u56de\u7684JSON\u6570\u636e\u3002<\/p>\n<\/p>\n<\/li>\n
  2. \n
    POST\u8bf7\u6c42<\/strong><\/p>\n<\/p>\n
    POST\u8bf7\u6c42\u7528\u4e8e\u5411\u670d\u52a1\u5668\u53d1\u9001\u6570\u636e\uff0c\u901a\u5e38\u7528\u4e8e\u63d0\u4ea4\u8868\u5355\u6216\u8005\u4e0a\u4f20\u6570\u636e\u3002<\/p>\n<\/p>\n
    import requests<\/p>\n
    data = {'key1': 'value1', 'key2': 'value2'}<\/p>\n
    response = requests.post('https:\/\/api.example.com\/data', data=data)<\/p>\n
    print(response.status_code)<\/p>\n
    print(response.json())<\/p>\n
    <\/code><\/pre>\n<\/p>\n
    \u5728\u8fd9\u4e2a\u4f8b\u5b50\u4e2d\uff0c\u6211\u4eec\u4f7f\u7528requests.post()<\/code>\u65b9\u6cd5\u53d1\u9001\u4e86\u4e00\u4e2aPOST\u8bf7\u6c42\uff0c\u5e76\u643a\u5e26\u4e86\u4e00\u4e2a\u5b57\u5178data<\/code>\u4f5c\u4e3a\u8bf7\u6c42\u4f53\u3002\u670d\u52a1\u5668\u4f1a\u63a5\u6536\u8fd9\u4e9b\u6570\u636e\u8fdb\u884c\u5904\u7406\u3002<\/p>\n<\/p>\n<\/li>\n<\/ol>\n
    \u4e8c\u3001API\u8ba4\u8bc1\u4e0e\u6388\u6743<\/h3>\n<\/p>\n
    \u5927\u591a\u6570API\u90fd\u9700\u8981\u67d0\u79cd\u5f62\u5f0f\u7684\u8ba4\u8bc1\u6216\u6388\u6743\uff0c\u4ee5\u786e\u4fdd\u53ea\u6709\u7ecf\u8fc7\u8ba4\u8bc1\u7684\u5ba2\u6237\u7aef\u80fd\u591f\u8bbf\u95ee\u8d44\u6e90\u3002\u5e38\u89c1\u7684\u8ba4\u8bc1\u65b9\u5f0f\u6709API Key\u3001OAuth\u7b49\u3002<\/p>\n<\/p>\n
      \n
    1. \n
      \u4f7f\u7528API Key\u8fdb\u884c\u8ba4\u8bc1<\/strong><\/p>\n<\/p>\n
      API Key\u662f\u6700\u7b80\u5355\u7684\u8ba4\u8bc1\u65b9\u5f0f\u3002\u901a\u5e38\u9700\u8981\u5728\u8bf7\u6c42\u5934\u4e2d\u5305\u542bAPI Key\u3002<\/p>\n<\/p>\n
      import requests<\/p>\n
      headers = {'Authorization': 'Bearer YOUR_API_KEY'}<\/p>\n
      response = requests.get('https:\/\/api.example.com\/data', headers=headers)<\/p>\n
      print(response.json())<\/p>\n
      <\/code><\/pre>\n<\/p>\n
      \u5728\u4e0a\u8ff0\u4ee3\u7801\u4e2d\uff0c\u6211\u4eec\u5c06API Key\u653e\u5728\u8bf7\u6c42\u5934\u7684Authorization<\/code>\u5b57\u6bb5\u4e2d\u3002<\/p>\n<\/p>\n<\/li>\n
    2. \n
      \u4f7f\u7528OAuth\u8fdb\u884c\u8ba4\u8bc1<\/strong><\/p>\n<\/p>\n
      OAuth\u662f\u4e00\u79cd\u66f4\u590d\u6742\u7684\u8ba4\u8bc1\u673a\u5236\uff0c\u6d89\u53ca\u5230\u83b7\u53d6\u8bbf\u95ee\u4ee4\u724c\u3002<\/p>\n<\/p>\n
      import requests<\/p>\n
      url = 'https:\/\/api.example.com\/oauth2\/token'<\/p>\n
      data = {'grant_type': 'client_credentials'}<\/p>\n
      auth = ('client_id', 'client_secret')<\/p>\n
      response = requests.post(url, data=data, auth=auth)<\/p>\n
      access_token = response.json().get('access_token')<\/p>\n
      headers = {'Authorization': f'Bearer {access_token}'}<\/p>\n
      response = requests.get('https:\/\/api.example.com\/data', headers=headers)<\/p>\n
      print(response.json())<\/p>\n
      <\/code><\/pre>\n<\/p>\n
      \u5728\u8fd9\u4e2a\u4f8b\u5b50\u4e2d\uff0c\u6211\u4eec\u9996\u5148\u901a\u8fc7POST\u8bf7\u6c42\u83b7\u53d6\u8bbf\u95ee\u4ee4\u724c\uff0c\u7136\u540e\u5728\u540e\u7eed\u8bf7\u6c42\u4e2d\u4f7f\u7528\u8be5\u4ee4\u724c\u8fdb\u884c\u8ba4\u8bc1\u3002<\/p>\n<\/p>\n<\/li>\n<\/ol>\n
      \u4e09\u3001\u5904\u7406API\u54cd\u5e94<\/h3>\n<\/p>\n
      API\u54cd\u5e94\u901a\u5e38\u4ee5JSON\u683c\u5f0f\u8fd4\u56de\uff0cPython\u63d0\u4f9b\u4e86\u7b80\u5355\u7684\u5de5\u5177\u6765\u5904\u7406\u8fd9\u4e9b\u6570\u636e\u3002<\/p>\n<\/p>\n
        \n
      1. \n
        \u89e3\u6790JSON\u6570\u636e<\/strong><\/p>\n<\/p>\n
        \u5f53API\u8fd4\u56deJSON\u6570\u636e\u65f6\uff0c\u53ef\u4ee5\u4f7f\u7528response.json()<\/code>\u65b9\u6cd5\u5c06\u5176\u8f6c\u6362\u4e3aPython\u5bf9\u8c61\uff08\u5982\u5b57\u5178\u6216\u5217\u8868\uff09\u3002<\/p>\n<\/p>\n
        response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
        data = response.json()<\/p>\n
        print(data['key'])<\/p>\n
        <\/code><\/pre>\n<\/p>\n<\/li>\n
      2. \n
        \u5904\u7406\u9519\u8bef\u54cd\u5e94<\/strong><\/p>\n<\/p>\n
        \u5728API\u8c03\u7528\u4e2d\uff0c\u5904\u7406\u9519\u8bef\u54cd\u5e94\u662f\u5f88\u91cd\u8981\u7684\u3002\u901a\u5e38\u53ef\u4ee5\u6839\u636e\u72b6\u6001\u7801\u8fdb\u884c\u5224\u65ad\u3002<\/p>\n<\/p>\n
        response = requests.get('https:\/\/api.example.com\/data')<\/p>\n
        if response.status_code == 200:<\/p>\n
            print('Success:', response.json())<\/p>\n
        elif response.status_code == 404:<\/p>\n
            print('Not Found')<\/p>\n
        else:<\/p>\n
            print('Error:', response.status_code)<\/p>\n
        <\/code><\/pre>\n<\/p>\n
        \u6839\u636e\u4e0d\u540c\u7684\u72b6\u6001\u7801\uff0c\u6211\u4eec\u53ef\u4ee5\u91c7\u53d6\u4e0d\u540c\u7684\u5904\u7406\u63aa\u65bd\u3002<\/p>\n<\/p>\n<\/li>\n<\/ol>\n
        \u56db\u3001\u4f7f\u7528API\u63d0\u4f9b\u7684Python SDK<\/h3>\n<\/p>\n
        \u8bb8\u591aAPI\u63d0\u4f9b\u4e86\u5b98\u65b9\u7684Python SDK\uff0c\u53ef\u4ee5\u7b80\u5316API\u8c03\u7528\u8fc7\u7a0b\u3002<\/p>\n<\/p>\n
          \n
        1. \n
          \u5b89\u88c5SDK<\/strong><\/p>\n<\/p>\n
          \u901a\u5e38\u53ef\u4ee5\u901a\u8fc7pip\u5b89\u88c5API\u7684SDK\u3002<\/p>\n<\/p>\n
          pip install example-api-sdk<\/p>\n
          <\/code><\/pre>\n<\/p>\n<\/li>\n
        2. \n
          \u4f7f\u7528SDK<\/strong><\/p>\n<\/p>\n
          \u4f7f\u7528SDK\u53ef\u4ee5\u907f\u514d\u624b\u52a8\u5904\u7406HTTP\u8bf7\u6c42\u548c\u54cd\u5e94\u3002<\/p>\n<\/p>\n
          from example_api_sdk import Client<\/p>\n
          client = Client(api_key='YOUR_API_KEY')<\/p>\n
          data = client.get_data()<\/p>\n
          print(data)<\/p>\n
          <\/code><\/pre>\n<\/p>\n
          SDK\u901a\u5e38\u63d0\u4f9b\u4e86\u66f4\u9ad8\u7ea7\u7684\u63a5\u53e3\uff0c\u4f7f\u5f97\u8c03\u7528API\u53d8\u5f97\u66f4\u52a0\u7b80\u5355\u548c\u76f4\u89c2\u3002<\/p>\n<\/p>\n<\/li>\n<\/ol>\n
          \u4e94\u3001\u5229\u7528\u7b2c\u4e09\u65b9\u5e93\u5c01\u88c5API<\/h3>\n<\/p>\n
          \u6709\u65f6\u5019\uff0c\u5f00\u53d1\u8005\u4f1a\u4f7f\u7528\u7b2c\u4e09\u65b9\u5e93\u5bf9API\u8fdb\u884c\u5c01\u88c5\uff0c\u4ee5\u4fbf\u66f4\u65b9\u4fbf\u5730\u4f7f\u7528\u3002<\/p>\n<\/p>\n
            \n
          1. \n
            \u9009\u62e9\u5408\u9002\u7684\u5e93<\/strong><\/p>\n<\/p>\n
            \u5728\u9009\u62e9\u7b2c\u4e09\u65b9\u5e93\u65f6\uff0c\u9700\u8981\u8003\u8651\u5176\u529f\u80fd\u3001\u6587\u6863\u3001\u793e\u533a\u652f\u6301\u7b49\u56e0\u7d20\u3002<\/p>\n<\/p>\n<\/li>\n
          2. \n
            \u4f7f\u7528\u5e93\u8fdb\u884cAPI\u8c03\u7528<\/strong><\/p>\n<\/p>\n
            \u7b2c\u4e09\u65b9\u5e93\u901a\u5e38\u4f1a\u5bf9API\u8c03\u7528\u8fdb\u884c\u5c01\u88c5\uff0c\u4f7f\u5176\u66f4\u6613\u4e8e\u4f7f\u7528\u3002<\/p>\n<\/p>\n
            import third_party_api<\/p>\n
            client = third_party_api.Client(api_key='YOUR_API_KEY')<\/p>\n
            data = client.fetch_data()<\/p>\n
            print(data)<\/p>\n
            <\/code><\/pre>\n<\/p>\n
            \u901a\u8fc7\u7b2c\u4e09\u65b9\u5e93\uff0c\u6211\u4eec\u53ef\u4ee5\u66f4\u4e13\u6ce8\u4e8e\u4e1a\u52a1\u903b\u8f91\uff0c\u800c\u4e0d\u5fc5\u5173\u5fc3\u5e95\u5c42\u7684HTTP\u7ec6\u8282\u3002<\/p>\n<\/p>\n<\/li>\n<\/ol>\n
            \u516d\u3001\u603b\u7ed3<\/h3>\n<\/p>\n
            Python\u63d0\u4f9b\u4e86\u591a\u79cd\u65b9\u5f0f\u4e0eAPI\u8fdb\u884c\u4ea4\u4e92\uff0c\u4ece\u7b80\u5355\u7684HTTP\u8bf7\u6c42\u5230\u4f7f\u7528\u9ad8\u7ea7SDK\u3002\u5728\u4f7f\u7528API\u65f6\uff0c\u7406\u89e3HTTP\u8bf7\u6c42\u7684\u57fa\u7840\u77e5\u8bc6\u3001\u638c\u63e1API\u8ba4\u8bc1\u4e0e\u6388\u6743\u7684\u6280\u5de7\u3001\u5b66\u4f1a\u89e3\u6790\u548c\u5904\u7406API\u54cd\u5e94\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002\u65e0\u8bba\u662f\u4f7f\u7528requests\u5e93\u8fd8\u662fAPI\u63d0\u4f9b\u7684SDK\uff0c\u9009\u62e9\u5408\u9002\u7684\u65b9\u6cd5\u80fd\u63d0\u9ad8\u5f00\u53d1\u6548\u7387\u3002\u6b64\u5916\uff0c\u5229\u7528\u7b2c\u4e09\u65b9\u5e93\u5c01\u88c5API\u4e5f\u662f\u4e00\u4e2a\u4e0d\u9519\u7684\u9009\u62e9\uff0c\u53ef\u4ee5\u4f7f\u4ee3\u7801\u66f4\u52a0\u7b80\u6d01\u548c\u6613\u4e8e\u7ef4\u62a4\u3002<\/p>\n<\/p>\n
            \u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n
             Python\u4f7f\u7528API\u7684\u57fa\u672c\u6b65\u9aa4\u662f\u4ec0\u4e48\uff1f<\/strong>
            \u4f7f\u7528API\u7684\u57fa\u672c\u6b65\u9aa4\u5305\u62ec\uff1a\u9996\u5148\uff0c\u4e86\u89e3API\u7684\u6587\u6863\uff0c\u638c\u63e1\u5176\u8bf7\u6c42\u65b9\u5f0f\uff08\u5982GET\u3001POST\u7b49\uff09\u3001\u53c2\u6570\u548c\u8fd4\u56de\u6570\u636e\u683c\u5f0f\u3002\u63a5\u7740\uff0c\u5229\u7528Python\u7684\u8bf7\u6c42\u5e93\uff08\u5982requests\uff09\u6765\u53d1\u9001HTTP\u8bf7\u6c42\u3002\u5904\u7406\u8fd4\u56de\u7684\u6570\u636e\u65f6\uff0c\u901a\u5e38\u9700\u8981\u5c06\u5176\u89e3\u6790\u4e3aJSON\u683c\u5f0f\u4ee5\u4fbf\u4e8e\u540e\u7eed\u64cd\u4f5c\u3002\u6700\u540e\uff0c\u5c06\u83b7\u53d6\u5230\u7684\u6570\u636e\u6574\u5408\u5230\u4f60\u7684\u5e94\u7528\u4e2d\u3002<\/p>\n
            \u5728Python\u4e2d\u5982\u4f55\u5904\u7406API\u8fd4\u56de\u7684JSON\u6570\u636e\uff1f<\/strong>
            \u5904\u7406API\u8fd4\u56de\u7684JSON\u6570\u636e\u76f8\u5bf9\u7b80\u5355\u3002\u4f7f\u7528Python\u7684\u5185\u7f6ejson\u5e93\u53ef\u4ee5\u8f7b\u677e\u5b9e\u73b0\u3002\u63a5\u6536\u5230\u6570\u636e\u540e\uff0c\u8c03\u7528json.loads()<\/code>\u5c06\u5b57\u7b26\u4e32\u683c\u5f0f\u7684JSON\u6570\u636e\u8f6c\u6362\u4e3aPython\u5b57\u5178\u3002\u8fd9\u6837\uff0c\u7528\u6237\u53ef\u4ee5\u901a\u8fc7\u5b57\u5178\u7684\u65b9\u5f0f\u8bbf\u95ee\u6570\u636e\uff0c\u63d0\u53d6\u6240\u9700\u7684\u4fe1\u606f\u3002<\/p>\n
            \u6709\u54ea\u4e9b\u6d41\u884c\u7684Python\u5e93\u53ef\u4ee5\u7b80\u5316API\u8c03\u7528\uff1f<\/strong>
            \u5728Python\u4e2d\uff0c\u6709\u51e0\u4e2a\u6d41\u884c\u7684\u5e93\u53ef\u4ee5\u7b80\u5316API\u8c03\u7528\u3002requests<\/code>\u5e93\u4ee5\u5176\u7b80\u5355\u6613\u7528\u800c\u53d7\u5230\u5e7f\u6cdb\u6b22\u8fce\uff0c\u652f\u6301\u591a\u79cdHTTP\u8bf7\u6c42\u65b9\u5f0f\u3002httpx<\/code>\u662f\u4e00\u4e2a\u73b0\u4ee3\u5316\u7684HTTP\u5ba2\u6237\u7aef\uff0c\u652f\u6301\u5f02\u6b65\u8bf7\u6c42\u3002\u5bf9\u4e8e\u9700\u8981\u5904\u7406\u590d\u6742API\u4ea4\u4e92\u7684\u7528\u6237\uff0c\u53ef\u4ee5\u8003\u8651\u4f7f\u7528AI<\/a>ohttp<\/code>\uff0c\u5b83\u63d0\u4f9b\u4e86\u5f02\u6b65HTTP\u8bf7\u6c42\u7684\u529f\u80fd\uff0c\u53ef\u4ee5\u63d0\u9ad8\u6027\u80fd\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"Python\u4f7f\u7528API\u7684\u65b9\u5f0f\u4e3b\u8981\u6709\uff1a\u901a\u8fc7HTTP\u8bf7\u6c42\u5e93\uff08\u5982requests\uff09\u8fdb\u884cAPI\u8c03\u7528\u3001\u4f7f\u7528API\u63d0\u4f9b\u7684P […]","protected":false},"author":3,"featured_media":934208,"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\/934204"}],"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=934204"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/934204\/revisions"}],"predecessor-version":[{"id":934209,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/934204\/revisions\/934209"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/934208"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=934204"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=934204"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=934204"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}