@hj24
This commit is contained in:
Xingyu Wang 2019-12-21 11:23:27 +08:00
parent 6bd3adb1ac
commit af3a3a218b

View File

@ -1,28 +1,28 @@
[#]: collector: (lujun9972) [#]: collector: (lujun9972)
[#]: translator: (hj24) [#]: translator: (hj24)
[#]: reviewer: ( ) [#]: reviewer: (wxy)
[#]: publisher: ( ) [#]: publisher: ( )
[#]: url: ( ) [#]: url: ( )
[#]: subject: (How to write a Python web API with Flask) [#]: subject: (How to write a Python web API with Flask)
[#]: via: (https://opensource.com/article/19/11/python-web-api-flask) [#]: via: (https://opensource.com/article/19/11/python-web-api-flask)
[#]: author: (Rachel Waston https://opensource.com/users/rachelwaston) [#]: author: (Rachel Waston https://opensource.com/users/rachelwaston)
如何使用Flask编写Python Web API 如何使用 Flask 编写 Python Web API
====== ======
这是一个快速教程用来展示如何通过Flask目前发展最迅速的Python框架之一来从服务器获取数据。 > 这是一个快速教程,用来展示如何通过 Flask目前发展最迅速的 Python 框架之一)来从服务器获取数据。
![spiderweb diagram][1] ![spiderweb diagram][1]
[Python][2]是一个以语法简洁著称的高级的,面向对象的程序语言。它一直都是一个用来构建RESTful API的顶级编程语言。 [Python][2] 是一个以语法简洁著称的高级的、面向对象的程序语言。它一直都是一个用来构建 RESTful API 的顶级编程语言。
[Flask][3]是一个高度可定制化的Python框架可以为开发人员提供用户访问数据方式的完全控制。Flask是一个基于Werkzeug的[WSGI][4]工具包和Jinja 2模板引擎的”微框架“。它是一个被设计来开发RESTful API的web框架。 [Flask][3] 是一个高度可定制化的 Python 框架可以为开发人员提供用户访问数据方式的完全控制。Flask 是一个基于 Werkzeug [WSGI][4] 工具包和 Jinja 2 模板引擎的”微框架“。它是一个被设计来开发 RESTful API web 框架。
Flask是Python发展最迅速的框架之一很多知名网站如Netflix, Pinterest, 和LinkedIn都将Flask纳入了它们的开发技术栈。下面是一个简单的示例展示了Flask是如何允许用户通过HTTP GET请求来从服务器获取数据的。 Flask Python 发展最迅速的框架之一很多知名网站如Netflix、Pinterest 和 LinkedIn 都将 Flask 纳入了它们的开发技术栈。下面是一个简单的示例,展示了 Flask 是如何允许用户通过 HTTP GET 请求来从服务器获取数据的。
### 初始化一个Flask应用 ### 初始化一个 Flask 应用
首先创建一个你的Flask项目的目录结构。你可以在你系统的任何地方来做这件事。
首先,创建一个你的 Flask 项目的目录结构。你可以在你系统的任何地方来做这件事。
``` ```
$ mkdir tutorial $ mkdir tutorial
@ -32,17 +32,14 @@ $ python3 -m venv env
$ source env/bin/activate $ source env/bin/activate
(env) $ pip3 install flask-restful (env) $ pip3 install flask-restful
Collecting flask-restful Collecting flask-restful
Downloading <https://files.pythonhosted.org/packages/17/44/6e49...8da4/Flask\_RESTful-0.3.7-py2.py3-none-any.whl> Downloading https://files.pythonhosted.org/packages/17/44/6e49...8da4/Flask_RESTful-0.3.7-py2.py3-none-any.whl
Collecting Flask&gt;=0.8 (from flask-restful) Collecting Flask>=0.8 (from flask-restful)
[...] [...]
``` ```
### 导入Flask模块 ### 导入 Flask 模块
Next, import the **flask** module and its **flask_restful** library into your **main.py** code:
然后,在你的**main.py**代码中导入**flask**模块和它的**flask_restful**库:
然后,在你的 `main.py` 代码中导入 `flask` 模块和它的 `flask_restful` 库:
``` ```
from flask import Flask from flask import Flask
@ -52,80 +49,76 @@ app = Flask(__name__)
api = Api(app) api = Api(app)
class Quotes(Resource): class Quotes(Resource):
    def get(self): def get(self):
        return { return {
            'William Shakespeare': { 'William Shakespeare': {
                'quote': ['Love all,trust a few,do wrong to none', 'quote': ['Love all,trust a few,do wrong to none',
                'Some are born great, some achieve greatness, and some greatness thrust upon them.'] 'Some are born great, some achieve greatness, and some greatness thrust upon them.']
        }, },
        'Linus': { 'Linus': {
            'quote': ['Talk is cheap. Show me the code.'] 'quote': ['Talk is cheap. Show me the code.']
            } }
        } }
api.add_resource(Quotes, '/') api.add_resource(Quotes, '/')
if __name__ == '__main__': if __name__ == '__main__':
    app.run(debug=True) app.run(debug=True)
``` ```
### 运行app ### 运行 app
Flask includes a built-in HTTP server for testing. Test the simple API you built:
Flask包含一个内建的用于测试的HTTP服务器。来测试一下这个你创建的简单的API
Flask 包含一个内建的用于测试的 HTTP 服务器。来测试一下这个你创建的简单的 API
``` ```
(env) $ python main.py (env) $ python main.py
 * Serving Flask app "main" (lazy loading) * Serving Flask app "main" (lazy loading)
 * Environment: production * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment. WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead. Use a production WSGI server instead.
 * Debug mode: on * Debug mode: on
 * Running on <http://127.0.0.1:5000/> (Press CTRL+C to quit) * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
``` ```
启动开发服务器时将启动Flask应用程序该应用程序包含一个名为 **get** 的方法来响应简单的HTTP GET请求。你可以通过 **wget**、**curl** 命令或者任意的web浏览器来测试它。 启动开发服务器时将启动 Flask 应用程序,该应用程序包含一个名为 `get` 的方法来响应简单的 HTTP GET 请求。你可以通过 `wget`、`curl` 命令或者任意的 web 浏览器来测试它。
``` ```
$ curl <http://localhost:5000> $ curl http://localhost:5000
{ {
    "William Shakespeare": { "William Shakespeare": {
        "quote": [ "quote": [
            "Love all,trust a few,do wrong to none", "Love all,trust a few,do wrong to none",
            "Some are born great, some achieve greatness, and some greatness thrust upon them." "Some are born great, some achieve greatness, and some greatness thrust upon them."
        ] ]
    }, },
    "Linus": { "Linus": {
        "quote": [ "quote": [
            "Talk is cheap. Show me the code." "Talk is cheap. Show me the code."
        ] ]
    } }
} }
``` ```
要查看使用Python和Flask的类似Web API的更复杂版本请导航至美国国会图书馆的[Chronicling America] [5]网站,该网站可提供有关这些信息的历史报纸和数字化报纸。 要查看使用 Python Flask 的类似 Web API 的更复杂版本,请导航至美国国会图书馆的 [Chronicling America][5] 网站,该网站可提供有关这些信息的历史报纸和数字化报纸。
### 为什么使用 Flask? ### 为什么使用 Flask?
Flask有以下几个主要的优点 Flask 有以下几个主要的优点:
1. Python很流行并且广泛被应用所以任何熟悉Python的人都可以使用Flask来开发。 1. Python 很流行并且广泛被应用,所以任何熟悉 Python 的人都可以使用 Flask 来开发。
2. 它轻巧而简约。 2. 它轻巧而简约。
3. 考虑安全性而构建。 3. 考虑安全性而构建。
4. 出色的文档,其中包含大量清晰,有效的示例代码。 4. 出色的文档,其中包含大量清晰,有效的示例代码。
还有一些潜在的缺点: 还有一些潜在的缺点:
1. 它轻巧而简约。但如果正在寻找具有大量捆绑库和预制组件的框架,那么这可能不是最佳选择。 1. 它轻巧而简约。但如果正在寻找具有大量捆绑库和预制组件的框架,那么这可能不是最佳选择。
2. 如果必须围绕Flask构建自己的框架则你可能会发现维护自定义项的成本可能会抵消使用Flask的好处。 2. 如果必须围绕 Flask 构建自己的框架,则你可能会发现维护自定义项的成本可能会抵消使用 Flask 的好处。
如果您要构建Web程序或API可以考虑选择Flask。它功能强大且健壮并且其优秀的项目文档使入门变得容易。试用一下评估一下看看它是否适合的项目。 如果你要构建 Web 程序或 API可以考虑选择 Flask。它功能强大且健壮并且其优秀的项目文档使入门变得容易。试用一下评估一下看看它是否适合的项目。
在本课中了解更多信息关于Python异常处理以及如何以安全的方式进行操作。 在本课中了解更多信息关于 Python 异常处理以及如何以安全的方式进行操作。
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
@ -134,7 +127,7 @@ via: https://opensource.com/article/19/11/python-web-api-flask
作者:[Rachel Waston][a] 作者:[Rachel Waston][a]
选题:[lujun9972][b] 选题:[lujun9972][b]
译者:[hj24](https://github.com/hj24) 译者:[hj24](https://github.com/hj24)
校对:[校对者ID](https://github.com/校对者ID) 校对:[wxy](https://github.com/wxy)
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译,[Linux中国](https://linux.cn/) 荣誉推出 本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译,[Linux中国](https://linux.cn/) 荣誉推出