????一種軟件架構(gòu)風格、設(shè)計風格,而不是標準,只是提供了一組設(shè)計原則和約束條件。它主要用于客戶端和服務(wù)器交互類的軟件。基于這個風格設(shè)計的軟件可以更簡潔,更有層次,更易于實現(xiàn)緩存等機制。
本文參考:https://baijiahao.baidu.com/s?id=1572275589970400&wfr=spider&for=pc
- 1.安裝和導包
$ pip install Flask-RESTful
安裝完成后就可以在代碼中帶入拓展包 from flask_restful import
- 2.不帶參數(shù)的請求
????resource方法來添加路由,方法的第一個參數(shù)是定義的類名,該類需要繼承"Resource"基類,其成員函數(shù)定義了不同的 HTTP 請求方法的邏輯,如:GET、POST等;第二個參數(shù)定義了 URL 路徑。
from flask import Flask, request
from flask_restful import Api ,Resource
app = Flask(__name__)
api = Api(app)
USER_LIST = {
'1': {'name':'Michael'},
'2': {'name':'Tom'},
}
class UserList(Resource):
def get(self):
return USER_LIST
def post(self):
user_id = int(max(USER_LIST.keys))
user_id = '%i' % user_id
USER_LIST[user_id] = {'name': request.form['name']}
return USER_LIST[user_id]
api.add_resource(UserList, '/users')
if __name__ == '__main__':
app.run(host='0.0.0.0', debug=True)
- 3.帶參數(shù)的請求
可以直接在定義類的成員函數(shù)下直接添加傳遞的參數(shù)
示例如下:
class User(Resource):
def get(self, user_id):
pass
def delete(self, user_id):
pass
def put(self, user_id):
pass
api.add_resource(User, '/users/')
- 4.參數(shù)解析
在 POST 或 PUT 請求中,直接訪問 form 表單并驗證的工作有些麻煩。Flask-RESTful 提供了"reqparse"庫來簡化。
from flask_restful import reqparse
parser = reqparse.RequestParser()
parser.add_argument('name', type=str)
args = parser.parse_args()
USER_LIST[user_id] = {'name': args['name']}
上述代碼中通過"parser.add.argument"方法來定義 form 表單字段,并指定其類型(本例中是字符型 str)。
然后在 PUT 函數(shù)中,就可以調(diào)用"parser.parse.args"來獲取表單內(nèi)容,并返回一個字典,該字典就包含了表單的內(nèi)容。
parser.parse.args"方法會自動驗證數(shù)據(jù)類型,并在類型不匹配時,返回 400 錯誤。
你還可以添加"strict"參數(shù),如"parser.parse.args(strict=True)",此時如果請求中出現(xiàn)未定義的參數(shù),也會返回 400 錯誤。
- 5.示例
from flask import Flask
from flask_restful import Api, Resource, reqparse, abort
USER_LIST = {
'1': {'name':'Michael'},
'2': {'name':'Tom'},
}
def abort_if_not_exist(user_id):
if user_id not in USER_LIST:
abort(404, message="User {} doesn't exist".format(user_id))
abort_if_not_exist(user_id)
return '', 204
args = parser.parse_args(strict=True)
return USER_LIST[user_id], 201
api.add_resource(User, '/users/')