web-dev-qa-db-ja.com

flask restful：GETリクエストにパラメーターを渡す

次の方法でGETリクエストをサポートするリソースを作成します。

/bar?key1=val1&key2=val2

このコードを試しましたが、機能していません

app = Flask(__name__)
api = Api(app)

class BarAPI(Resource):
    def get(key1, key2):
        return jsonify(dict(data=[key1, key2]))

api.add_resource(BarAPI, '/bar', endpoint='bar')

ありがとう！

pythonrestflaskflask-restful
33
Rugnar

Flaskはリクエストを介して引数を解析できます

_from flask import request
_

GETパラメーターを必要とするブロックでは、次の行を使用できます。 GETは@app.route()宣言で宣言されています。

_args = request.args
print (args) # For debugging
no1 = args['key1']
no2 = args['key2']
return jsonify(dict(data=[no1, no2])) # or whatever is required
_
22
Aditya

編集：これは、フラスコレストフルでこれを行うための推奨される方法ではなくなりました！reqparseオブジェクトは非推奨です。 docs 推奨代替案。

reqparseを使用します。 Flask-restful docs で別の例を見ることができます。

パラメーターの検証を実行し、jsonifyを必要としません。

from flask import Flask
from flask_restful import Resource, Api, reqparse

app = Flask(__name__)
api = Api(app)

class BarAPI(Resource):
    def get(self):

        parser = reqparse.RequestParser()
        parser.add_argument('key1', type=str)
        parser.add_argument('key2', type=str)

        return parser.parse_args()

api.add_resource(BarAPI, '/bar', endpoint='bar')

if __name__ == '__main__':
    app.run(debug=True)
33
Paul Rooney

reqparseは非推奨であるため、 WebArgs ライブラリを使用したソリューションは次のとおりです。

from flask import Flask
from flask_restful import Api, Resource, abort
from webargs import fields, validate
from webargs.flaskparser import use_kwargs, parser

app = Flask(__name__)
api = Api(app)

class Foo(Resource):
    args = {
        'bar': fields.Str(
            required=True,
            validate=validate.OneOf(['baz', 'qux']),
        ),
    }

    @use_kwargs(args)
    def get(self, bar):
        return {'bar': bar}

api.add_resource(Foo, '/foo', endpoint='foo')

# This error handler is necessary for usage with Flask-RESTful.
@parser.error_handler
def handle_request_parsing_error(err):
    abort(422, errors=err.messages)

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

その他の例については、WebArgsリポジトリの Flask-RESTfulの例 を参照してください。

27
severen