{"id":204001,"date":"2025-05-29T13:19:09","date_gmt":"2025-05-29T05:19:09","guid":{"rendered":"https:\/\/server.hk\/cnblog\/204001\/"},"modified":"2025-05-29T13:19:09","modified_gmt":"2025-05-29T05:19:09","slug":"%e5%a6%82%e4%bd%95%e4%bd%bf%e7%94%a8-flask-%e5%92%8c-python-%e5%88%9b%e5%bb%ba-restful-api","status":"publish","type":"post","link":"https:\/\/server.hk\/cnblog\/204001\/","title":{"rendered":"\u5982\u4f55\u4f7f\u7528 Flask \u548c Python \u521b\u5efa RESTful API"},"content":{"rendered":"<p><b><\/b>     <\/p>\n<h1>\u5982\u4f55\u4f7f\u7528 Flask \u548c Python \u521b\u5efa RESTful API<\/h1>\n<p>\u5c0f\u4f19\u4f34\u4eec\u5bf9\u6587\u7ae0\u7f16\u7a0b\u611f\u5174\u8da3\u5417\uff1f\u662f\u5426\u6b63\u5728\u5b66\u4e60\u76f8\u5173\u77e5\u8bc6\u70b9\uff1f\u5982\u679c\u662f\uff0c\u90a3\u4e48\u672c\u6587\u300a\u5982\u4f55\u4f7f\u7528 Flask \u548c Python \u521b\u5efa RESTful API\u300b\uff0c\u5c31\u5f88\u9002\u5408\u4f60\uff0c\u672c\u7bc7\u6587\u7ae0\u8bb2\u89e3\u7684\u77e5\u8bc6\u70b9\u4e3b\u8981\u5305\u62ec\u3002\u5728\u4e4b\u540e\u7684\u6587\u7ae0\u4e2d\u4e5f\u4f1a\u591a\u591a\u5206\u4eab\u76f8\u5173\u77e5\u8bc6\u70b9\uff0c\u5e0c\u671b\u5bf9\u5927\u5bb6\u7684\u77e5\u8bc6\u79ef\u7d2f\u6709\u6240\u5e2e\u52a9\uff01<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/www.17golang.com\/uploads\/20241016\/1729082740670fb574af9fb.jpg\" class=\"aligncenter\"><\/p>\n<p>restful api \u5728\u73b0\u4ee3\u5f00\u53d1\u4e2d\u81f3\u5173\u91cd\u8981\uff0c\u5b83\u5141\u8bb8\u4e0d\u540c\u7684\u7cfb\u7edf\u4ee5\u9ad8\u6548\u4e14\u53ef\u6269\u5c55\u7684\u65b9\u5f0f\u8fdb\u884c\u901a\u4fe1\u3002 python \u53ca\u5176 flask \u6846\u67b6\u63d0\u4f9b\u4e86\u4e00\u79cd\u7b80\u5355\u800c\u5f3a\u5927\u7684\u65b9\u6cd5\u6765\u521b\u5efa api\u3002\u5728\u672c\u6307\u5357\u4e2d\uff0c\u6211\u4eec\u5c06\u63a2\u7d22\u5982\u4f55\u4f7f\u7528 flask \u521b\u5efa restful api\uff0c\u6db5\u76d6\u4ece\u57fa\u7840\u77e5\u8bc6\u5230 http \u5ba2\u6237\u7aef\u7684\u8eab\u4efd\u9a8c\u8bc1\u548c\u4f7f\u7528\u7684\u6240\u6709\u5185\u5bb9\u3002<\/p>\n<p>\u5728\u5f00\u59cb\u7f16\u5199\u4ee3\u7801\u4e4b\u524d\uff0c\u4e86\u89e3\u4ec0\u4e48\u662f restful api \u975e\u5e38\u91cd\u8981\u3002 api\uff08\u5e94\u7528\u7a0b\u5e8f\u7f16\u7a0b\u63a5\u53e3\uff09\u662f\u4e00\u7ec4\u5141\u8bb8\u4e00\u4e2a\u8f6f\u4ef6\u4e0e\u53e6\u4e00\u4e2a\u8f6f\u4ef6\u901a\u4fe1\u7684\u89c4\u5219\u3002 <strong>rest\uff08\u8868\u8ff0\u6027\u72b6\u6001\u4f20\u8f93\uff09<\/strong> \u6837\u5f0f\u5b9a\u4e49\u4e86 api \u5fc5\u987b\u9075\u5faa\u7684\u4e00\u7ec4\u539f\u5219\uff1a<\/p>\n<ul>\n<li> <strong>\u5ba2\u6237\u7aef-\u670d\u52a1\u5668<\/strong>\uff1a\u5ba2\u6237\u7aef\uff08\u4f7f\u7528api\u200b\u200b\uff09\u548c\u670d\u52a1\u5668\uff08\u63d0\u4f9b\u6570\u636e\uff09\u4e4b\u95f4\u7684\u5206\u79bb\u3002<\/li>\n<li> <strong>\u65e0\u72b6\u6001<\/strong>\uff1a\u5ba2\u6237\u7aef\u53d1\u51fa\u7684\u6bcf\u4e2a\u8bf7\u6c42\u90fd\u5fc5\u987b\u5305\u542b\u670d\u52a1\u5668\u5904\u7406\u6240\u9700\u7684\u6240\u6709\u4fe1\u606f\u3002<\/li>\n<li> <strong>\u53ef\u7f13\u5b58<\/strong>\uff1a\u53ef\u4ee5\u7f13\u5b58 api \u54cd\u5e94\u4ee5\u63d0\u9ad8\u6027\u80fd\u3002<\/li>\n<li> <strong>\u7edf\u4e00\u63a5\u53e3<\/strong>\uff1a\u5ba2\u6237\u7aef\u548c\u670d\u52a1\u5668\u4e4b\u95f4\u7684\u901a\u4fe1\u5fc5\u987b\u4ee5\u6807\u51c6\u5316\u7684\u65b9\u5f0f\u8fdb\u884c\uff0c\u4f7f\u7528http\u65b9\u6cd5\uff0c\u4f8b\u5982get\u3001post\u3001put\u548cdelete\u3002<\/li>\n<\/ul>\n<p>\u73b0\u5728\u6211\u4eec\u5c06\u521b\u5efa\u4e00\u4e2a\u7b80\u5355\u7684 api \u6765\u7ba1\u7406\u7528\u6237\u5217\u8868\u3002\u8be5 api \u5c06\u5141\u8bb8\u60a8\u6dfb\u52a0\u3001\u7f16\u8f91\u3001\u67e5\u770b\u548c\u5220\u9664\u7528\u6237\u3002<\/p>\n<p>\u9996\u5148\uff0c\u786e\u4fdd\u4f60\u5df2\u7ecf\u5b89\u88c5\u4e86 flask\u3002\u5982\u679c\u6ca1\u6709\uff0c\u60a8\u53ef\u4ee5\u4f7f\u7528 pip \u5b89\u88c5\uff1a<\/p>\n<pre>pip install flask\n<\/pre>\n<p>\u6211\u4eec\u7684\u9879\u76ee\u5c06\u5177\u6709\u4ee5\u4e0b\u7ed3\u6784\uff1a<\/p>\n<pre>\/api_flask\n\u2502\n\u251c\u2500\u2500 app.py\n\u2514\u2500\u2500 requirements.txt\n<\/pre>\n<p>\u5728 app.py \u6587\u4ef6\u4e2d\uff0c\u6211\u4eec\u9996\u5148\u5bfc\u5165\u5fc5\u8981\u7684\u5e93\u5e76\u914d\u7f6e\u6211\u4eec\u7684 flask \u5e94\u7528\u7a0b\u5e8f\uff1a<\/p>\n<pre>from flask import flask, jsonify, request\n\napp = flask(__name__)\n\n# dados simulados\nusers = [\n    {'id': 1, 'name': 'alice', 'email': 'alice@example.com'},\n    {'id': 2, 'name': 'bob', 'email': 'bob@example.com'}\n]\n<\/pre>\n<p>\u73b0\u5728\uff0c\u8ba9\u6211\u4eec\u4e3a<strong>\u67e5\u770b<\/strong>\u3001<strong>\u6dfb\u52a0<\/strong>\u3001<strong>\u66f4\u65b0<\/strong>\u548c<strong>\u5220\u9664<\/strong>\u7528\u6237\u521b\u5efa\u7aef\u70b9\u3002<\/p>\n<h4> 4.1.\u5217\u51fa\u7528\u6237\u7684\u7aef\u70b9 <\/h4>\n<p>\u6211\u4eec\u5c06\u4f7f\u7528<strong>get<\/strong>\u65b9\u6cd5\u5217\u51fa\u6240\u6709\u7528\u6237\uff1a<\/p>\n<pre>@app.route('\/users', methods=['get'])\ndef get_users():\n    return jsonify(users), 200\n<\/pre>\n<h4> 4.2.\u83b7\u53d6\u7279\u5b9a\u7528\u6237\u7684\u7aef\u70b9 <\/h4>\n<p>\u6211\u4eec\u5c06\u4f7f\u7528 <strong>get<\/strong> \u65b9\u6cd5\u548c\u7528\u6237 id \u6765\u83b7\u53d6\u7279\u5b9a\u7528\u6237\u7684\u8be6\u7ec6\u4fe1\u606f\uff1a<\/p>\n<pre>@app.route('\/users\/&lt;int:user_id&gt;', methods=['get'])\ndef get_user(user_id):\n    user = next((user for user in users if user['id'] == user_id), none)\n    if user:\n        return jsonify(user), 200\n    else:\n        return jsonify({'message': 'user not found'}), 404\n<\/pre>\n<h4> 4.3.\u521b\u5efa\u65b0\u7528\u6237\u7684\u7aef\u70b9 <\/h4>\n<p><strong>post<\/strong> \u65b9\u6cd5\u5c06\u7528\u4e8e\u6dfb\u52a0\u65b0\u7528\u6237\u3002\u5ba2\u6237\u7aef\u5c06\u4ee5 json \u683c\u5f0f\u53d1\u9001\u6570\u636e\u3002<\/p>\n<pre>@app.route('\/users', methods=['post'])\ndef create_user():\n    data = request.get_json()\n    new_user = {\n        'id': len(users) + 1,\n        'name': data['name'],\n        'email': data['email']\n    }\n    users.append(new_user)\n    return jsonify(new_user), 201\n<\/pre>\n<h4> 4.4.\u66f4\u65b0\u7528\u6237\u7684\u7aef\u70b9 <\/h4>\n<p>\u8fd9\u91cc\u6211\u4eec\u4f7f\u7528<strong>put<\/strong>\u65b9\u6cd5\u6765\u66f4\u65b0\u73b0\u6709\u7528\u6237\u7684\u6570\u636e\uff1a<\/p>\n<pre>@app.route('\/users\/&lt;int:user_id&gt;', methods=['put'])\ndef update_user(user_id):\n    data = request.get_json()\n    user = next((user for user in users if user['id'] == user_id), none)\n    if user:\n        user['name'] = data['name']\n        user['email'] = data['email']\n        return jsonify(user), 200\n    else:\n        return jsonify({'message': 'user not found'}), 404\n<\/pre>\n<h4> 4.5.\u5220\u9664\u7528\u6237\u7684\u7aef\u70b9 <\/h4>\n<p>\u6211\u4eec\u4f7f\u7528<strong>delete<\/strong>\u65b9\u6cd5\u6765\u5220\u9664\u7528\u6237\uff1a<\/p>\n<pre>@app.route('\/users\/&lt;int:user_id&gt;', methods=['delete'])\ndef delete_user(user_id):\n    global users\n    users = [user for user in users if user['id'] != user_id]\n    return jsonify({'message': 'user deleted'}), 200\n<\/pre>\n<p>\u73b0\u5728\uff0c\u53ea\u9700\u8fd0\u884c\u6211\u4eec\u7684\u5e94\u7528\u7a0b\u5e8f\uff1a<\/p>\n<pre>if __name__ == '__main__':\n    app.run(debug=true)\n<\/pre>\n<p>\u8fd0\u884capp.py\u6587\u4ef6\uff0c\u6211\u4eec\u7684api\u5c06\u5728http:\/\/127.0.0.1:5000\/users\u53ef\u7528\u3002<\/p>\n<p>\u8981\u4e3a\u6211\u4eec\u7684 api \u6dfb\u52a0\u4e00\u5c42\u5b89\u5168\u6027\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528 <strong>jwt\uff08json web \u4ee4\u724c\uff09<\/strong>\u3002\u4f7f\u7528 jwt\uff0c\u6211\u4eec\u53ef\u4ee5\u786e\u4fdd\u53ea\u6709\u7ecf\u8fc7\u8eab\u4efd\u9a8c\u8bc1\u7684\u7528\u6237\u624d\u80fd\u8bbf\u95ee\u67d0\u4e9b\u7aef\u70b9\u3002<\/p>\n<h4> 6.1.\u5b89\u88c5 flask-jwt-extend <\/h4>\n<p>\u5b89\u88c5\u6240\u9700\u7684\u6269\u5c55\uff1a<\/p>\n<pre>pip install flask-jwt-extended\n<\/pre>\n<h4> 6.2.\u914d\u7f6e jwt <\/h4>\n<p>\u66f4\u65b0\u60a8\u7684 app.py \u6587\u4ef6\u4ee5\u5305\u542b jwt \u8eab\u4efd\u9a8c\u8bc1\uff1a<\/p>\n<pre>from flask_jwt_extended import jwtmanager, create_access_token, jwt_required\n\napp.config['jwt_secret_key'] = 'your-secret-key'  # troque pela sua chave secreta\njwt = jwtmanager(app)\n\n# login para obter o token\n@app.route('\/login', methods=['post'])\ndef login():\n    data = request.get_json()\n    if data['username'] == 'admin' and data['password'] == 'admin':\n        access_token = create_access_token(identity={'username': 'admin'})\n        return jsonify(access_token=access_token), 200\n    else:\n        return jsonify({'message': 'invalid credentials'}), 401\n\n# exemplo de endpoint protegido\n@app.route('\/protected', methods=['get'])\n@jwt_required()\ndef protected():\n    return jsonify({'message': 'access granted to protected endpoint'}), 200\n<\/pre>\n<p>\u73b0\u5728\uff0c\u5f53\u8bbf\u95ee \/protected \u7aef\u70b9\u65f6\uff0c\u9700\u8981\u5728\u8bf7\u6c42\u6807\u5934\u4e2d\u53d1\u9001 jwt \u4ee4\u724c\u6765\u9a8c\u8bc1\u7528\u6237\u8eab\u4efd\u3002<\/p>\n<p>\u8981\u4f7f\u7528 api\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528 <strong>postman<\/strong> \u7b49\u5de5\u5177\u6216 python \u4e2d\u7684 <strong>requests<\/strong> \u7b49\u5e93\u3002<\/p>\n<pre>import requests\n\n# Consumindo o endpoint de listagem de usu\u00e1rios\nresponse = requests.get('http:\/\/127.0.0.1:5000\/users')\nprint(response.json())\n<\/pre>\n<p>      \u7248\u672c\u58f0\u660e \u672c\u6587\u8f6c\u8f7d\u4e8e\uff1adev.to \u5982\u6709\u4fb5\u72af\uff0c\u8bf7\u8054\u7cfb\u5220\u9664<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u5982\u4f55\u4f7f\u7528 Flask \u548c Pyt&#46;&#46;&#46;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4925],"tags":[],"class_list":["post-204001","post","type-post","status-publish","format-standard","hentry","category-4925"],"_links":{"self":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/posts\/204001","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/comments?post=204001"}],"version-history":[{"count":0,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/posts\/204001\/revisions"}],"wp:attachment":[{"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/media?parent=204001"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/categories?post=204001"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/server.hk\/cnblog\/wp-json\/wp\/v2\/tags?post=204001"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}