Flaskで応答ヘッダーを設定するにはどうすればよいですか?


98

これは私のコードです:

@app.route('/hello', methods=["POST"])
def hello():
    resp = make_response()
    resp.headers['Access-Control-Allow-Origin'] = '*'
    return resp

ただし、ブラウザからサーバーにリクエストを送信すると、次のエラーが発生します。

XMLHttpRequest cannot load http://localhost:5000/hello. 
No 'Access-Control-Allow-Origin' header is present on the requested resource.

私もこのアプローチを試し、リクエストの「後で」応答ヘッダーを設定しました:

@app.after_request
def add_header(response):
    response.headers['Access-Control-Allow-Origin'] = '*'
    return response

サイコロはありません。同じエラーが発生します。ルート関数に応答ヘッダーを設定する方法はありますか?このようなものが理想的です:

@app.route('/hello', methods=["POST"])
    def hello(response): # is this a thing??
        response.headers['Access-Control-Allow-Origin'] = '*'
        return response

とにかくこれを行うには見つけることができません。助けてください。

編集する

私がそのようなPOSTリクエストでURLをカールさせれば:

curl -iX POST http://localhost:5000/hello

私はこの応答を受け取ります:

HTTP/1.0 500 INTERNAL SERVER ERROR
Content-Type: text/html
Content-Length: 291
Server: Werkzeug/0.9.6 Python/2.7.6
Date: Tue, 16 Sep 2014 03:58:42 GMT

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>500 Internal Server Error</title>
<h1>Internal Server Error</h1>
<p>The server encountered an internal error and was unable to complete your request.  Either the server is overloaded or there is an error in the application.</p>

何か案は?

回答:


96

あなたはこれをかなり簡単に行うことができます:

@app.route("/")
def home():
    resp = flask.Response("Foo bar baz")
    resp.headers['Access-Control-Allow-Origin'] = '*'
    return resp

Flask.ResponseFlask.make_response()を見てください。

しかし、何かがあなたに別の問題があることを教えてくれますafter_request

編集
私はあなたがすでにmake_responseそれを行う方法の1つであるあなたがすでに使っていることに気づきました。前に言ったように、after_requestうまくいくはずでした。curlを介してエンドポイントにアクセスして、ヘッダーが何であるかを確認してください。

curl -i http://127.0.0.1:5000/your/endpoint

見るべき

> curl -i 'http://127.0.0.1:5000/'
HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 11
Access-Control-Allow-Origin: *
Server: Werkzeug/0.8.3 Python/2.7.5
Date: Tue, 16 Sep 2014 03:47:13 GMT

Access-Control-Allow-Originヘッダーに注目してください。

編集2
私が思ったように、あなたは500を取得しているので、あなたが思ったようにヘッダーを設定していません。app.debug = Trueアプリを起動する前に追加して、もう一度お試しください。問題の根本原因を示す出力が表示されるはずです。

例えば:

@app.route("/")
def home():
    resp = flask.Response("Foo bar baz")
    user.weapon = boomerang
    resp.headers['Access-Control-Allow-Origin'] = '*'
    return resp

これが下部にある、きれいにフォーマットされたhtmlエラーページが表示されます(curlコマンドに役立ちます)

Traceback (most recent call last):
...
  File "/private/tmp/min.py", line 8, in home
    user.weapon = boomerang
NameError: global name 'boomerang' is not defined

24

make_responseフラスコのようなものの使用

@app.route("/")
def home():
    resp = make_response("hello") #here you could use make_response(render_template(...)) too
    resp.headers['Access-Control-Allow-Origin'] = '*'
    return resp

フラスコのドキュメントから、

Flask.make_response(* args)

ビューで追加のヘッダーを設定する必要がある場合があります。ビューは応答オブジェクトを返す必要はありませんが、Flask自体によって応答オブジェクトに変換される値を返すことができるため、ヘッダーを追加するのは難しくなります。この関数は、returnを使用する代わりに呼び出すことができ、ヘッダーを添付するために使用できる応答オブジェクトを取得します。


あなたは、引数にリクエストを送信することができます:flask.pocoo.org/docs/0.10/api/#flask.Flask.make_response
tokland

5

この仕事は私にとって

from flask import Flask
from flask import Response

app = Flask(__name__)

@app.route("/")
def home():
    return Response(headers={'Access-Control-Allow-Origin':'*'})

if __name__ == "__main__":
    app.run()

2
return Response(headers={'Access-Control-Allow-Origin':'*'})きれいに見える表記もあります。
Hermann、

4

これは、私のフラスコアプリケーションにヘッダーを追加する方法で、完全に機能しました

@app.after_request
def add_header(response):
    response.headers['X-Content-Type-Options'] = 'nosniff'
    return response

0

以下を使用してFlaskアプリケーションコンテキストを使用し、Python Flaskアプリケーションで応答ヘッダーを設定できます。 flask.g

使用するFlaskアプリケーションコンテキストで応答ヘッダーを設定するこの方法flask.gはスレッドセーフであり、アプリケーションの任意のファイルからカスタム属性および動的属性を設定するために使用できます。これは、ヘルパークラスからカスタム/動的応答ヘッダーを設定する場合に特に役立ちます。他のファイル(ミドルウェアなど)からもアクセスできます。flask.gはグローバルであり、そのリクエストスレッドに対してのみ有効です。

このアプリから呼び出されている別のapi / http呼び出しから応答ヘッダーを読み取り、抽出して、このアプリの応答ヘッダーとして設定する場合は、

サンプルコード:ファイル: helper.py

import flask
from flask import request, g
from multidict import CIMultiDict
from asyncio import TimeoutError as HttpTimeout
from aiohttp import ClientSession

    def _extract_response_header(response)
      """
      extracts response headers from response object 
      and stores that required response header in flask.g app context
      """
      headers = CIMultiDict(response.headers)
      if 'my_response_header' not in g:
        g.my_response_header= {}
        g.my_response_header['x-custom-header'] = headers['x-custom-header']


    async def call_post_api(post_body):
      """
      sample method to make post api call using aiohttp clientsession
      """
      try:
        async with ClientSession() as session:
          async with session.post(uri, headers=_headers, json=post_body) as response:
            responseResult = await response.read()
            _extract_headers(response, responseResult)
            response_text = await response.text()
      except (HttpTimeout, ConnectionError) as ex:
        raise HttpTimeout(exception_message)

ファイル: middleware.py

import flask
from flask import request, g

class SimpleMiddleWare(object):
    """
    Simple WSGI middleware
    """

    def __init__(self, app):
        self.app = app
        self._header_name = "any_request_header"

    def __call__(self, environ, start_response):
        """
        middleware to capture request header from incoming http request
        """
        request_id_header = environ.get(self._header_name)
        environ[self._header_name] = request_id_header

        def new_start_response(status, response_headers, exc_info=None):
            """
            set custom response headers
            """
            # set the request header as response header
            response_headers.append((self._header_name, request_id_header))
            # this is trying to access flask.g values set in helper class & set that as response header
            values = g.get(my_response_header, {})
            if values.get('x-custom-header'):
                response_headers.append(('x-custom-header', values.get('x-custom-header')))
            return start_response(status, response_headers, exc_info)

        return self.app(environ, new_start_response)

メインクラスからミドルウェアを呼び出す

ファイル: main.py

from flask import Flask
import asyncio
from gevent.pywsgi import WSGIServer
from middleware import SimpleMiddleWare

    app = Flask(__name__)
    app.wsgi_app = SimpleMiddleWare(app.wsgi_app)
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.