Flask-RESTful是一個用于快速創建RESTful API接口的Flask擴展。使用Flask-RESTful可以很快速方便地創建一個RESTful風格的接口應用程序。
1、安裝
pip install flask_restful
2、全部代碼
from flask import Flaskfrom flask_restful import reqparse, abort, Api, Resourceapp = Flask(__name__)api = Api(app)TODOS = { 'todo1': {'task': 'build'}, 'todo2': {'task': 'bui2'}, 'todo3': {'task': 'bui3'}}parser = reqparse.RequestParser()parser.add_argument('task')class Todo(Resource): def get(self, todo_id): return TODOS[todo_id] def delete(self, todo_id): del TODOS[todo_id] return '', 204 def put(self, todo_id): args = parser.parse_args() task = {'task': args['task']} TODOS[todo_id] = task return task, 201class TodoList(Resource): def get(self): return TODOSapi.add_resource(TodoList, '/todos')api.add_resource(Todo, '/todos/<todo_id>')if __name__ == '__main__': app.run(debug=True)3、代碼說明
1）. 初始化
在當前程序初始化一個flask-restful的api實例:
api = Api(app)
2）. 定義資源類
資源類是restful接口的具體實現，需要繼承Resource類。在類中可以定義get、post等符合restful規范的接口。
class Todo(Resource): def get(self, todo_id): return TODOS[todo_id] def delete(self, todo_id): del TODOS[todo_id] return '', 204 def put(self, todo_id): args = parser.parse_args() task = {'task': args['task']} TODOS[todo_id] = task return task, 2013). 參數解析
雖然 Flask 提供了簡單的方法訪問請求數據, 但是對于表單數據處理還是比較麻煩. Flask-RESTful 提供了 reqparse 一種類似 argparse 參數解析機制以簡化參數處理.
parser = reqparse.RequestParser()： reqparse使用RequestParser() 可以從 flask.Request.values，以及 flask.Request.json 解析值。這里創建了一個解析對象parser。
parser.add_argument('task')：向parser對象中添加你要關注的命令行參數和選項，每一個add_argument方法對應一個你要關注的參數或選項。
parser.parse_args()：調用parse_args()方法進行解析，解析成功之后即可使用。
4). add_argument擴展
對于必傳的參數，可以設置required=True
parser.add_argument('name', type=str, required=True,help="Name cannot be blank!")傳多個值，使用 action='append'
parser.add_argument('name', type=str, action='append')使用：
curl http://api.example.com -d "Name=bob" -d "Name=sue" -d "Name=joe"
獲取的參數為：
args = parser.parse_args()args['name'] # ['bob', 'sue', 'joe']
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持VEVB武林網。
新聞熱點
疑難解答
