การร้องขอไปยัง RESTful API โดยใช้ python

ฉันมี RESTful API ที่ฉันได้สัมผัสโดยใช้การใช้ Elasticsearch บนอินสแตนซ์ของ EC2 เพื่อจัดทำดัชนีคลังเนื้อหา ฉันสามารถค้นหาด้วยการเรียกใช้สิ่งต่อไปนี้จากเทอร์มินัลของฉัน (MacOSX):

curl -XGET 'http://ES_search_demo.com/document/record/_search?pretty=true' -d '{
  "query": {
    "bool": {
      "must": [
        {
          "text": {
            "record.document": "SOME_JOURNAL"
          }
        },
        {
          "text": {
            "record.articleTitle": "farmers"
          }
        }
      ],
      "must_not": [],
      "should": []
    }
  },
  "from": 0,
  "size": 50,
  "sort": [],
  "facets": {}
}'

ฉันจะเปลี่ยนเป็นคำขอ API โดยใช้python/requestsหรือpython/urllib2(ไม่แน่ใจว่าจะใช้คำขอใด - ได้ใช้ urllib2 แต่ได้ยินว่าคำขอนั้นดีกว่า ... ) ฉันจะผ่านเป็นส่วนหัวหรืออย่างอื่นได้หรือไม่

ใช้คำขอ :

import requests
url = 'http://ES_search_demo.com/document/record/_search?pretty=true'
data = '''{
  "query": {
    "bool": {
      "must": [
        {
          "text": {
            "record.document": "SOME_JOURNAL"
          }
        },
        {
          "text": {
            "record.articleTitle": "farmers"
          }
        }
      ],
      "must_not": [],
      "should": []
    }
  },
  "from": 0,
  "size": 50,
  "sort": [],
  "facets": {}
}'''
response = requests.post(url, data=data)

ขึ้นอยู่กับชนิดของการตอบกลับ API ของคุณคุณอาจต้องการดูresponse.textหรือresponse.json()(หรืออาจตรวจสอบresponse.status_codeก่อน) ดูเอกสารฉบับย่อที่นี่โดยเฉพาะในส่วนนี้

การใช้คำร้องขอและjsonทำให้มันง่าย

1. โทรหา API
2. สมมติว่า API คืนค่า JSON ให้แยกอ็อบเจ็กต์ JSON ลงใน Pict dython โดยใช้json.loadsฟังก์ชัน
3. วนรอบ dict เพื่อดึงข้อมูล

โมดูลคำขอให้ฟังก์ชันที่มีประโยชน์แก่คุณในการวนลูปเพื่อความสำเร็จและความล้มเหลว

if(Response.ok): จะช่วยคุณตรวจสอบว่าการเรียก API ของคุณสำเร็จหรือไม่ (รหัสตอบกลับ - 200)

Response.raise_for_status() จะช่วยให้คุณดึงรหัส http ที่ส่งคืนจาก API

ด้านล่างเป็นรหัสตัวอย่างสำหรับการเรียก API ดังกล่าว นอกจากนี้ยังสามารถพบได้ในGitHub รหัสจะถือว่า API นั้นใช้การตรวจสอบสิทธิ์แบบแยกย่อย คุณสามารถข้ามสิ่งนี้หรือใช้โมดูลการพิสูจน์ตัวตนที่เหมาะสมอื่น ๆ เพื่อรับรองความถูกต้องของไคลเอ็นต์ที่เรียกใช้ API

#Python 2.7.6
#RestfulClient.py

import requests
from requests.auth import HTTPDigestAuth
import json

# Replace with the correct URL
url = "http://api_url"

# It is a good practice not to hardcode the credentials. So ask the user to enter credentials at runtime
myResponse = requests.get(url,auth=HTTPDigestAuth(raw_input("username: "), raw_input("Password: ")), verify=True)
#print (myResponse.status_code)

# For successful API call, response code will be 200 (OK)
if(myResponse.ok):

    # Loading the response data into a dict variable
    # json.loads takes in only binary or string variables so using content to fetch binary content
    # Loads (Load String) takes a Json file and converts into python data structure (dict or list, depending on JSON)
    jData = json.loads(myResponse.content)

    print("The response contains {0} properties".format(len(jData)))
    print("\n")
    for key in jData:
        print key + " : " + jData[key]
else:
  # If response code is not ok (200), print the resulting http error code with description
    myResponse.raise_for_status()

ดังนั้นคุณต้องการส่งผ่านข้อมูลในเนื้อความของคำขอ GET ดีกว่าที่จะทำใน POST call คุณสามารถทำได้โดยใช้คำขอทั้งสอง

คำขอดิบ

GET http://ES_search_demo.com/document/record/_search?pretty=true HTTP/1.1
Host: ES_search_demo.com
Content-Length: 183
User-Agent: python-requests/2.9.0
Connection: keep-alive
Accept: */*
Accept-Encoding: gzip, deflate

{
  "query": {
    "bool": {
      "must": [
        {
          "text": {
            "record.document": "SOME_JOURNAL"
          }
        },
        {
          "text": {
            "record.articleTitle": "farmers"
          }
        }
      ],
      "must_not": [],
      "should": []
    }
  },
  "from": 0,
  "size": 50,
  "sort": [],
  "facets": {}
}

ตัวอย่างการโทรพร้อมคำขอ

import requests

def consumeGETRequestSync():
data = '{
  "query": {
    "bool": {
      "must": [
        {
          "text": {
            "record.document": "SOME_JOURNAL"
          }
        },
        {
          "text": {
            "record.articleTitle": "farmers"
          }
        }
      ],
      "must_not": [],
      "should": []
    }
  },
  "from": 0,
  "size": 50,
  "sort": [],
  "facets": {}
}'
url = 'http://ES_search_demo.com/document/record/_search?pretty=true'
headers = {"Accept": "application/json"}
# call get service with headers and params
response = requests.get(url,data = data)
print "code:"+ str(response.status_code)
print "******************"
print "headers:"+ str(response.headers)
print "******************"
print "content:"+ str(response.text)

consumeGETRequestSync()

ด้านล่างนี้เป็นโปรแกรมสำหรับเรียกใช้ api ที่เหลือใน python-

import requests
url = 'https://url'
data = '{  "platform": {    "login": {      "userName": "name",      "password": "pwd"    }  } }'
response = requests.post(url, data=data,headers={"Content-Type": "application/json"})
print(response)
sid=response.json()['platform']['login']['sessionId']   //to extract the detail from response
print(response.text)
print(sid)