快捷導(dǎo)航

flask-restful使用總結(jié)

更新時(shí)間：2018年12月04日 15:30:19 作者：stray

Flask-RESTful是一個(gè)用于快速創(chuàng)建RESTful API接口的Flask擴(kuò)展。，這篇文章主要介紹了flask-restful使用總結(jié)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

Flask-RESTful是一個(gè)用于快速創(chuàng)建RESTful API接口的Flask擴(kuò)展。使用Flask-RESTful可以很快速方便地創(chuàng)建一個(gè)RESTful風(fēng)格的接口應(yīng)用程序。

1、安裝

pip install flask_restful

2、全部代碼

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

app = 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, 201


class TodoList(Resource):
  def get(self):
    return TODOS


api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/<todo_id>')

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

3、代碼說(shuō)明

1）. 初始化

在當(dāng)前程序初始化一個(gè)flask-restful的api實(shí)例:

api = Api(app)

2）. 定義資源類(lèi)

資源類(lèi)是restful接口的具體實(shí)現(xiàn)，需要繼承Resource類(lèi)。在類(lèi)中可以定義get、post等符合restful規(guī)范的接口。

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, 201

3). 參數(shù)解析

雖然 Flask 提供了簡(jiǎn)單的方法訪問(wèn)請(qǐng)求數(shù)據(jù), 但是對(duì)于表單數(shù)據(jù)處理還是比較麻煩. Flask-RESTful 提供了 reqparse 一種類(lèi)似 argparse 參數(shù)解析機(jī)制以簡(jiǎn)化參數(shù)處理.

parser = reqparse.RequestParser()： reqparse使用RequestParser() 可以從 flask.Request.values，以及 flask.Request.json 解析值。這里創(chuàng)建了一個(gè)解析對(duì)象parser。

parser.add_argument('task')：向parser對(duì)象中添加你要關(guān)注的命令行參數(shù)和選項(xiàng)，每一個(gè)add_argument方法對(duì)應(yīng)一個(gè)你要關(guān)注的參數(shù)或選項(xiàng)。

parser.parse_args()：調(diào)用parse_args()方法進(jìn)行解析，解析成功之后即可使用。

4). add_argument擴(kuò)展

對(duì)于必傳的參數(shù)，可以設(shè)置required=True

parser.add_argument('name', type=str, required=True,
help="Name cannot be blank!")

傳多個(gè)值，使用 action='append'

parser.add_argument('name', type=str, action='append')

使用：

curl http://api.example.com -d "Name=bob" -d "Name=sue" -d "Name=joe"

獲取的參數(shù)為：

args = parser.parse_args()
args['name']  # ['bob', 'sue', 'joe']

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

flask-restful使用總結(jié)

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線(xiàn)小工具