Flask-RESTful 指南：快速构建REST API

需积分: 20 52 浏览量更新于2024-07-02 收藏 254KB PDF 举报

"这是一份关于Flask-RESTful的英文PDF指南，主要涵盖了该扩展的用户指南、API参考以及一些额外的注意事项。作者包括Kyle Conroy、Ryan Horn和Frank Stratton，更新日期为2020年2月6日。" 在Python Web开发中，Flask是一个轻量级的Web应用框架，而Flask-RESTful则是基于Flask的一个扩展，专门用于快速构建RESTful风格的API。RESTful API设计遵循了一种分层、无状态和客户端-服务器架构的原则，使得接口更加简洁、高效。Flask-RESTful在Flask的基础上提供了一些便利的功能，帮助开发者以最少的设置实现最佳实践。 **1. 用户指南** 1.1 安装安装Flask-RESTful非常简单，只需要通过pip命令即可： ``` pip install flask-restful ``` 如果需要获取最新的开发版本，可以直接从GitHub克隆源代码： ``` git clone https://github.com/flask-restful/flask-restful ``` 1.2 快速启动快速启动部分将引导你创建第一个Flask-RESTful应用，通常涉及定义资源(Resource)和路由(Route)。 1.3 请求解析 Flask-RESTful提供了请求解析功能，允许你从HTTP请求中提取数据，如查询参数、路径参数、请求体等，可以方便地处理JSON、XML等多种数据格式。 1.4 输出字段你可以自定义输出字段，以控制API响应的结构和内容，例如添加元数据，或者对返回的数据进行格式化。 1.5 扩展Flask-RESTful Flask-RESTful设计得十分灵活，允许你通过继承或注册新的类和方法来扩展其功能，以适应不同的业务需求。 1.6 中级使用这部分内容深入介绍了如何利用Flask-RESTful构建更复杂的API，包括错误处理、认证授权、分页等高级特性。 **2. API参考** 这部分文档提供了Flask-RESTful所有模块和类的详细说明，帮助开发者了解每个函数、类和方法的作用和用法。 **3. 额外注意事项** 这里包含了运行测试、调试技巧、性能优化等实际开发中可能遇到的问题和解决方案。 **4. Python模块索引和全文索引** 这两部分是文档的索引，方便读者查找特定的模块或关键词。这份Flask-RESTful指南是学习和开发RESTful API的重要参考资料，它涵盖了从基础到进阶的所有关键概念，对于Python开发者来说，尤其是那些使用Flask框架的人来说，是非常宝贵的工具。

Flask-RESTful Documentation, Release 0.3.8

(continued from previous page)

if __name__ == '__main__':

app.run(debug=True)

You can try it like this:

$ curl http://localhost:5000/todo1 -d "data=Remember the milk" -X PUT

{"todo1": "Remember the milk"}

$ curl http://localhost:5000/todo1

{"todo1": "Remember the milk"}

$ curl http://localhost:5000/todo2 -d "data=Change my brakepads" -X PUT

{"todo2": "Change my brakepads"}

$ curl http://localhost:5000/todo2

{"todo2": "Change my brakepads"}

Or from python if you have the requests library installed:

>>> from requests import put, get

>>> put('http://localhost:5000/todo1', data={'data': 'Remember the milk'}).json()

{u'todo1': u'Remember the milk'}

>>> get('http://localhost:5000/todo1').json()

{u'todo1': u'Remember the milk'}

>>> put('http://localhost:5000/todo2', data={'data': 'Change my brakepads'}).json()

{u'todo2': u'Change my brakepads'}

>>> get('http://localhost:5000/todo2').json()

{u'todo2': u'Change my brakepads'}

Flask-RESTful understands multiple kinds of return values from view methods. Similar to Flask, you can return any

iterable and it will be converted into a response, including raw Flask response objects. Flask-RESTful also support

setting the response code and response headers using multiple return values, as shown below:

class Todo1(Resource):

def get(self):

# Default to 200 OK

return {'task': 'Hello world'}

class Todo2(Resource):

def get(self):

# Set the response code to 201

return {'task': 'Hello world'}, 201

class Todo3(Resource):

def get(self):

# Set the response code to 201 and return custom headers

return {'task': 'Hello world'}, 201, {'Etag': 'some-opaque-string'}

1.2.3 Endpoints

Many times in an API, your resource will have multiple URLs. You can pass multiple URLs to the

add_resource() method on the Api object. Each one will be routed to your Resource

api.add_resource(HelloWorld,

'/',

'/hello')

You can also match parts of the path as variables to your resource methods.

1.2. Quickstart 5

Flask-RESTful Documentation, Release 0.3.8

api.add_resource(Todo,

'/todo/<int:todo_id>', endpoint='todo_ep')

1.2.4 Argument Parsing

While Flask provides easy access to request data (i.e. querystring or POST form encoded data), it’s still a pain to

validate form data. Flask-RESTful has built-in support for request data validation using a library similar to argparse.

from flask_restful import reqparse

parser = reqparse.RequestParser()

parser.add_argument('rate', type=int, help='Rate to charge for this resource')

args = parser.parse_args()

Note: Unlike the argparse module, reqparse.RequestParser.parse_args() returns a Python dictionary

instead of a custom data structure.

Using the reqparse module also gives you sane error messages for free. If an argument fails to pass validation,

Flask-RESTful will respond with a 400 Bad Request and a response highlighting the error.

$ curl -d 'rate=foo' http://127.0.0.1:5000/todos

{'status': 400, 'message': 'foo cannot be converted to int'}

The inputs module provides a number of included common conversion functions such as inputs.date() and

inputs.url().

Calling parse_args with strict=True ensures that an error is thrown if the request includes arguments your

parser does not deﬁne.

args = parser.parse_args(strict=True)

1.2.5 Data Formatting

By default, all ﬁelds in your return iterable will be rendered as-is. While this works great when you’re just dealing

with Python data structures, it can become very frustrating when working with objects. To solve this problem, Flask-

RESTful provides the fields module and the marshal_with() decorator. Similar to the Django ORM and

WTForm, you use the fields module to describe the structure of your response.

from flask_restful import fields, marshal_with

resource_fields = {

'task': fields.String,

'uri': fields.Url('todo_ep')

}

class TodoDao(object):

def __init__(self, todo_id, task):

self.todo_id = todo_id

self.task = task

# This field will not be sent in the response

self.status = 'active'

(continues on next page)

6 Chapter 1. User’s Guide

剩余49页未读，继续阅读

l402072123

粉丝: 47
资源: 1

Flask-RESTful 指南：快速构建REST API

STM32F1开发指南-库函数版本_V3.1 .pdf

nRF52840开发指南-上册.pdf.docx

STM32F429开发指南-HAL库版本（正点原子 ）

STM32F4开发指南-寄存器版本_V1.0.pdf

STM32F1开发指南-库函数版本_V3.0.pdf

STM32F7开发指南-寄存器版本_V1.1.pdf

STM32库开发实战指南-M4：50-读写内部FLASH[归纳].pdf

nRF52832开发指南-上册.pdf

nRF52840开发指南-上册.pdf

AWTK开发手册-AWTK开发实践指南-中文手册.pdf

最新资源

STM32F429开发指南-HAL库版本（正点原子）