如何使用Flask编写Python Web API,


如何使用Flask编写Python Web API

这是一个快速教程,用来展示如何通过 Flask(目前发展最迅速的 Python 框架之一)来从服务器获取数据。

Python 是一个以语法简洁著称的高级的、面向对象的程序语言。它一直都是一个用来构建 RESTful API 的顶级编程语言。

Flask 是一个高度可定制化的 Python 框架,可以为开发人员提供用户访问数据方式的完全控制。Flask 是一个基于 Werkzeug 的 WSGI 工具包和 Jinja 2 模板引擎的”微框架“。它是一个被设计来开发 RESTful API 的 web 框架。

Flask 是 Python 发展最迅速的框架之一,很多知名网站如:Netflix、Pinterest 和 LinkedIn 都将 Flask 纳入了它们的开发技术栈。下面是一个简单的示例,展示了 Flask 是如何允许用户通过 HTTP GET 请求来从服务器获取数据的。

初始化一个 Flask 应用

首先,创建一个你的 Flask 项目的目录结构。你可以在你系统的任何地方来做这件事。

  1. $ mkdir tutorial
  2. $ cd tutorial
  3. $ touch main.py
  4. $ python3 -m venv env
  5. $ source env/bin/activate
  6. (env) $ pip3 install flask-restful
  7. Collecting flask-restful
  8. Downloading https://files.pythonhosted.org/packages/17/44/6e49...8da4/Flask_RESTful-0.3.7-py2.py3-none-any.whl
  9. Collecting Flask>=0.8 (from flask-restful)
  10. [...]

导入 Flask 模块

然后,在你的 main.py 代码中导入 flask 模块和它的 flask_restful 库:

  1. from flask import Flask
  2. from flask_restful import Resource, Api
  3.  
  4. app = Flask(__name__)
  5. api = Api(app)
  6.  
  7. class Quotes(Resource):
  8. def get(self):
  9. return {
  10. 'William Shakespeare': {
  11. 'quote': ['Love all,trust a few,do wrong to none',
  12. 'Some are born great, some achieve greatness, and some greatness thrust upon them.']
  13. },
  14. 'Linus': {
  15. 'quote': ['Talk is cheap. Show me the code.']
  16. }
  17. }
  18.  
  19. api.add_resource(Quotes, '/')
  20.  
  21. if __name__ == '__main__':
  22. app.run(debug=True)

运行 app

Flask 包含一个内建的用于测试的 HTTP 服务器。来测试一下这个你创建的简单的 API:

  1. (env) $ python main.py
  2. * Serving Flask app "main" (lazy loading)
  3. * Environment: production
  4. WARNING: This is a development server. Do not use it in a production deployment.
  5. Use a production WSGI server instead.
  6. * Debug mode: on
  7. * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

启动开发服务器时将启动 Flask 应用程序,该应用程序包含一个名为 get 的方法来响应简单的 HTTP GET 请求。你可以通过 wgetcurl 命令或者任意的 web 浏览器来测试它。

  1. $ curl http://localhost:5000
  2. {
  3. "William Shakespeare": {
  4. "quote": [
  5. "Love all,trust a few,do wrong to none",
  6. "Some are born great, some achieve greatness, and some greatness thrust upon them."
  7. ]
  8. },
  9. "Linus": {
  10. "quote": [
  11. "Talk is cheap. Show me the code."
  12. ]
  13. }
  14. }

要查看使用 Python 和 Flask 的类似 Web API 的更复杂版本,请导航至美国国会图书馆的 Chronicling America 网站,该网站可提供有关这些信息的历史报纸和数字化报纸。

为什么使用 Flask?

Flask 有以下几个主要的优点:

还有一些潜在的缺点:

如果你要构建 Web 程序或 API,可以考虑选择 Flask。它功能强大且健壮,并且其优秀的项目文档使入门变得容易。试用一下,评估一下,看看它是否适合你的项目。

在本课中了解更多信息关于 Python 异常处理以及如何以安全的方式进行操作。

评论关闭