Блог

Я новичок в экспериментах с созданием API, и мне было интересно создать приложение, которое возвращает данные в формате XML только по запросу post API.

Приведенный ниже код flask-restful — это просто улучшенная версия того, как выполнить XML-ответ из примеров репозитория git для просмотра.

 from simplexml import dumps
from flask import make_response, Flask
from flask_restful import Api, Resource

def output_xml(data, code, headers=None):
    """Makes a Flask response with a XML encoded body"""
    resp = make_response(dumps({'response' :data}), code)
    resp.headers.extend(headers or {})
    return resp


tou = [{
    "startTime": "2:00PM",
    "duration": "6 Hours",
    "numberOfIntervals" : 3,
    "intervalDuration" : "1 hour,4 hour,1 hour",
    "typicalIntervalValues" : "$0.50,$0.75,$0.50"
}]



app = Flask(__name__)
api = Api(app, default_mediatype='application/xml')
api.representations['application/xml'] = output_xml


class call(Resource):
    def post(self):
        callInfo = {"notification" : "True",
                "startTime" : "2:00PM",
                "duration" : "6 Hours",
                "randomization": "None",
                "rampUp" : "None",
                "recovery" : "None",
                "numberOfSignals" : "2",
                 "signalNameSimple" : [{
                    "signalType" : "level",
                    "units" : "None",
                    "numberOfIntervals" : "None",
                    "intervalDuration" : "None",
                    "typicalIntervalValues" : "1,2,1",
                    "signalTarget" : "None"}],
                 "signalNameElectricityPrice" : [{
                    "signalType" : "price",
                    "units" : "USD per kWh",
                    "numberOfIntervals" : "3",
                    "intervalDuration" : "1 hour,4 hour,1 hour",
                    "typicalIntervalValues" : "$0.50,$0.75,$0.50",
                    "signalTarget" : "None"}]
                        }
        return callInfo



api.add_resource(call, '/api/v1/cpp/scenario/three')


if __name__ == '__main__':
    app.run(debug=False)
  

Проблема, которая у меня есть (возможно, это даже не проблема), заключается в том, что приложение Flask-restful возвращает XML-ответ, только если он определен в заголовке запросов, иначе он возвращает ответ JSON. Например, в приведенном ниже коде, если у меня нет headers={'Accept': 'application/xml'} этого скрипта, произойдет ошибка, потому что ответ приложения Flask-restful имеет формат JSON.

 import requests
import xml
from xml.etree import ElementTree


response = requests.post("http://127.0.0.1:5000/api/v1/cpp/scenario/three", headers={'Accept': 'application/xml'})
#response = requests.post("http://127.0.0.1:5000/api/v1/cpp/scenario/three")


root = ElementTree.fromstring(response.content)
for child in root.iter('*'):
    print(child.tag)
  

ВОПРОС, как я могу изменить свое приложение Flask, чтобы оно возвращало только XML?Если это кажется глупым вопросом, может ли кто-нибудь подробнее рассказать о том, зачем API понадобятся JSON и XML? Сценарий реального мира, который я надеюсь узнать о том, как это реализовать, использует только XML, и я обеспокоен тем, что наличие этого дополнительного headers={'Accept': 'application/xml'} создаст проблему, поскольку устройства, взаимодействующие с API, являются просто «машинами», а не людьми с пользовательскими способностями программирования на python. Если бы кто-нибудь мог помочь мне понять, что типично для индустрии API, возможно, это тоже немного помогло бы 🙂