Создание запроса к RESTful API с использованием python

131

У меня есть API RESTful, который я раскрыл с помощью реализации 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, но лучше слышите, что запросы...)? Я передаю как заголовок или иначе?

Теги:
rest
elasticsearch

4 ответа

223
Лучший ответ

Использование requests:

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). Подробнее см. В документах quickstart особенно в этом разделе.

Поделиться
  • 3
    я думаю, это должно быть: response = запросы. пост (URL, данные = данные)
  • 6
    «request.get» не принимает параметр «data». Он может принимать необязательный параметр «params», который обычно является строкой запроса, содержащей слово dict. Если для получения данных необходима полезная нагрузка (например, приведенный в примере пример), необходимо использовать «request.post». Кроме того, использование библиотеки "json" облегчает анализ ответа json.
Показать ещё 3 комментария
66

Используя requests и json делает это просто.

  • Вызов API
  • Предполагая, что API возвращает JSON, проанализируйте объект JSON в Python dict с использованием функции json.loads
  • Пройдите через dict для извлечения информации.

requests модуль предоставляет вам полезную функцию для достижения успеха и неудачи.

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()
Поделиться
  • 1
    Последняя часть с итерацией по ключам не всегда будет работать, потому что документ JSON может иметь массив в качестве элемента верхнего уровня. Таким образом, было бы ошибкой пытаться получить jData[key]
  • 0
    @DenisTheMenace, если это массив, как мне его обойти?
Показать ещё 3 комментария
9

Таким образом, вы хотите передать данные в теле запроса GET, лучше было бы сделать это при вызове POST. Вы можете добиться этого, используя оба Запроса.

Необработанный запрос

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()
Поделиться
  • 0
    получил там мертвую ссылку
  • 0
    Переменная headers должна использоваться: запросы.get (... headers = headers, ....)
6

Ниже приведена программа для выполнения остальных 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)
Поделиться

Ещё вопросы

Сообщество Overcoder
Наверх
Меню