包含pythontutorial的词条

如何使用python 开发一个api

使用 Python 和 Flask 设计 RESTful API

近些年来 REST (REpresentational State Transfer) 已经变成了 web services 和 web APIs 的标配。

在本文中我将向你展示如何简单地使用 Python 和 Flask 框架来创建一个 RESTful 的 web service。

什么是 REST？

六条设计规范定义了一个 REST 系统的特点:

客户端-服务器: 客户端和服务器之间隔离，服务器提供服务，客户端进行消费。

无状态: 从客户端到服务器的每个请求都必须包含理解请求所必需的信息。换句话说， 服务器不会存储客户端上一次请求的信息用来给下一次使用。

可缓存: 服务器必须明示客户端请求能否缓存。

分层系统: 客户端和服务器之间的通信应该以一种标准的方式，就是中间层代替服务器做出响应的时候，客户端不需要做任何变动。

统一的接口: 服务器和客户端的通信方法必须是统一的。

按需编码: 服务器可以提供可执行代码或脚本，为客户端在它们的环境中执行。这个约束是唯一一个是可选的。

什么是一个 RESTful 的 web service？

REST 架构的最初目的是适应万维网的 HTTP 协议。

RESTful web services 概念的核心就是“资源”。 资源可以用?URI?来表示。客户端使用 HTTP 协议定义的方法来发送请求到这些 URIs，当然可能会导致这些被访问的”资源“状态的改变。

HTTP 标准的方法有如下:

========== ?===================== ?==================================

HTTP 方法 ? 行为 ? ? ? ? ? ? ? ? ? 示例

========== ?===================== ?==================================

GET ? ? ? ? 获取资源的信息 ? ? ? ?

GET ? ? ? ? 获取某个特定资源的信息

POST ? ? ? ?创建新资源 ? ? ? ? ? ?

PUT ? ? ? ? 更新资源 ? ? ? ? ? ? ?

DELETE ? ? ?删除资源 ? ? ? ? ? ? ?

========== ?====================== ==================================

REST 设计不需要特定的数据格式。在请求中数据可以以?JSON?形式, 或者有时候作为 url 中查询参数项。

设计一个简单的 web service

坚持 REST 的准则设计一个 web service 或者 API 的任务就变成一个标识资源被展示出来以及它们是怎样受不同的请求方法影响的练习。

比如说，我们要编写一个待办事项应用程序而且我们想要为它设计一个 web service。要做的第一件事情就是决定用什么样的根 URL 来访问该服务。例如，我们可以通过这个来访问:

http://[hostname]/todo/api/v1.0/

在这里我已经决定在 URL 中包含应用的名称以及 API 的版本号。在 URL 中包含应用名称有助于提供一个命名空间以便区分同一系统上的其它服务。在 URL 中包含版本号能够帮助以后的更新，如果新版本中存在新的和潜在不兼容的功能，可以不影响依赖于较旧的功能的应用程序。

下一步骤就是选择将由该服务暴露(展示)的资源。这是一个十分简单地应用，我们只有任务，因此在我们待办事项中唯一的资源就是任务。

我们的任务资源将要使用 HTTP 方法如下:

========== ?=============================================== ?=============================

HTTP 方法 ? URL ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?动作

========== ?=============================================== ?==============================

GET ? ? ? ? http://[hostname]/todo/api/v1.0/tasks ? ? ? ? ? ?检索任务列表

GET ? ? ? ? http://[hostname]/todo/api/v1.0/tasks/[task_id] ?检索某个任务

POST ? ? ? ?http://[hostname]/todo/api/v1.0/tasks ? ? ? ? ? ?创建新任务

PUT ? ? ? ? http://[hostname]/todo/api/v1.0/tasks/[task_id] ?更新任务

DELETE ? ? ?http://[hostname]/todo/api/v1.0/tasks/[task_id] ?删除任务

========== ?================================================ =============================

我们定义的任务有如下一些属性:

id: 任务的唯一标识符。数字类型。

title: 简短的任务描述。字符串类型。

description: 具体的任务描述。文本类型。

done: 任务完成的状态。布尔值。

目前为止关于我们的 web service 的设计基本完成。剩下的事情就是实现它！

Flask 框架的简介

如果你读过?Flask Mega-Tutorial 系列，就会知道 Flask 是一个简单却十分强大的 Python web 框架。

在我们深入研究 web services 的细节之前，让我们回顾一下一个普通的 Flask Web 应用程序的结构。

我会首先假设你知道 Python 在你的平台上工作的基本知识。 我将讲解的例子是工作在一个类 Unix 操作系统。简而言之，这意味着它们能工作在 Linux，Mac OS X 和 Windows(如果你使用Cygwin)。 如果你使用 Windows 上原生的 Python 版本的话，命令会有所不同。

让我们开始在一个虚拟环境上安装 Flask。如果你的系统上没有 virtualenv，你可以从?上下载:

$ mkdir todo-api

$ cd todo-api

$ virtualenv flask

New python executable in flask/bin/python

Installing setuptools............................done.

Installing pip...................done.

$ flask/bin/pip install flask

既然已经安装了 Flask，现在开始创建一个简单地网页应用，我们把它放在一个叫 app.py 的文件中:

#!flask/bin/pythonfrom flask import Flaskapp = Flask(__name__)@app.route('/')def index():

? ?return "Hello, World!"if __name__ == '__main__':

? ?app.run(debug=True)

为了运行这个程序我们必须执行 app.py:

$ chmod a+x app.py

$ ./app.py

* Running on

* Restarting with reloader

现在你可以启动你的网页浏览器，输入??看看这个小应用程序的效果。

简单吧？现在我们将这个应用程序转换成我们的 RESTful service！

使用 Python 和 Flask 实现 RESTful services

使用 Flask 构建 web services 是十分简单地，比我在?Mega-Tutorial?中构建的完整的服务端的应用程序要简单地多。

在 Flask 中有许多扩展来帮助我们构建 RESTful services，但是在我看来这个任务十分简单，没有必要使用 Flask 扩展。

我们 web service 的客户端需要添加、删除以及修改任务的服务，因此显然我们需要一种方式来存储任务。最直接的方式就是建立一个小型的数据库，但是数据库并不是本文的主体。学习在 Flask 中使用合适的数据库，我强烈建议阅读?Mega-Tutorial。

这里我们直接把任务列表存储在内存中，因此这些任务列表只会在 web 服务器运行中工作，在结束的时候就失效。 这种方式只是适用我们自己开发的 web 服务器，不适用于生产环境的 web 服务器， 这种情况一个合适的数据库的搭建是必须的。

我们现在来实现 web service 的第一个入口:

#!flask/bin/pythonfrom flask import Flask, jsonifyapp = Flask(__name__)tasks = [

? ?{

? ? ? ?'id': 1,

? ? ? ?'title': u'Buy groceries',

? ? ? ?'description': u'Milk, Cheese, Pizza, Fruit, Tylenol',

? ? ? ?'done': False

? ?},

? ?{

? ? ? ?'id': 2,

? ? ? ?'title': u'Learn Python',

? ? ? ?'description': u'Need to find a good Python tutorial on the web',

? ? ? ?'done': False

? ?}]@app.route('/todo/api/v1.0/tasks', methods=['GET'])def get_tasks():

? ?return jsonify({'tasks': tasks})if __name__ == '__main__':

? ?app.run(debug=True)

正如你所见，没有多大的变化。我们创建一个任务的内存数据库，这里无非就是一个字典和数组。数组中的每一个元素都具有上述定义的任务的属性。

取代了首页，我们现在拥有一个 get_tasks 的函数，访问的 URI 为 /todo/api/v1.0/tasks，并且只允许 GET 的 HTTP 方法。

这个函数的响应不是文本，我们使用 JSON 数据格式来响应，Flask 的 jsonify 函数从我们的数据结构中生成。

使用网页浏览器来测试我们的 web service 不是一个最好的注意，因为网页浏览器上不能轻易地模拟所有的 HTTP 请求的方法。相反，我们会使用 curl。如果你还没有安装 curl 的话，请立即安装它。

通过执行 app.py，启动 web service。接着打开一个新的控制台窗口，运行以下命令:

$ curl -i

HTTP/1.0 200 OK

Content-Type: application/json

Content-Length: 294

Server: Werkzeug/0.8.3 Python/2.7.3

Date: Mon, 20 May 2013 04:53:53 GMT

{

?"tasks": [

? ?{

? ? ?"description": "Milk, Cheese, Pizza, Fruit, Tylenol",

? ? ?"done": false,

? ? ?"id": 1,

? ? ?"title": "Buy groceries"

? ?},

? ?{

? ? ?"description": "Need to find a good Python tutorial on the web",

? ? ?"done": false,

? ? ?"id": 2,

? ? ?"title": "Learn Python"

? ?}

?]

}

我们已经成功地调用我们的 RESTful service 的一个函数！

现在我们开始编写 GET 方法请求我们的任务资源的第二个版本。这是一个用来返回单独一个任务的函数:

from flask import abort@app.route('/todo/api/v1.0/tasks/int:task_id', methods=['GET'])def get_task(task_id):

? ?task = filter(lambda t: t['id'] == task_id, tasks)

? ?if len(task) == 0:

? ? ? ?abort(404)

? ?return jsonify({'task': task[0]})

第二个函数有些意思。这里我们得到了 URL 中任务的 id，接着 Flask 把它转换成 函数中的 task_id 的参数。

我们用这个参数来搜索我们的任务数组。如果我们的数据库中不存在搜索的 id，我们将会返回一个类似 404 的错误，根据 HTTP 规范的意思是 “资源未找到”。

如果我们找到相应的任务，那么我们只需将它用 jsonify 打包成 JSON 格式并将其发送作为响应，就像我们以前那样处理整个任务集合。

调用 curl 请求的结果如下:

$ curl -i

HTTP/1.0 200 OK

Content-Type: application/json

Content-Length: 151

Server: Werkzeug/0.8.3 Python/2.7.3

Date: Mon, 20 May 2013 05:21:50 GMT

{

?"task": {

? ?"description": "Need to find a good Python tutorial on the web",

? ?"done": false,

? ?"id": 2,

? ?"title": "Learn Python"

?}

}

$ curl -i

HTTP/1.0 404 NOT FOUND

Content-Type: text/html

Content-Length: 238

Server: Werkzeug/0.8.3 Python/2.7.3

Date: Mon, 20 May 2013 05:21:52 GMT

!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"

title404 Not Found/title

h1Not Found/h1

pThe requested URL was not found on the server./ppIf you ? ? entered the URL manually please check your spelling and try again./p

当我们请求 id #2 的资源时候，我们获取到了，但是当我们请求 #3 的时候返回了 404 错误。有关错误奇怪的是返回的是 HTML 信息而不是 JSON，这是因为 Flask 按照默认方式生成 404 响应。由于这是一个 Web service 客户端希望我们总是以 JSON 格式回应，所以我们需要改善我们的 404 错误处理程序:

from flask import make_response@app.errorhandler(404)def not_found(error):

? ?return make_response(jsonify({'error': 'Not found'}), 404)

我们会得到一个友好的错误提示:

$ curl -i

HTTP/1.0 404 NOT FOUND

Content-Type: application/json

Content-Length: 26

Server: Werkzeug/0.8.3 Python/2.7.3

Date: Mon, 20 May 2013 05:36:54 GMT

{

?"error": "Not found"

}

接下来就是 POST 方法，我们用来在我们的任务数据库中插入一个新的任务:

from flask import request@app.route('/todo/api/v1.0/tasks', methods=['POST'])def create_task():

? ?if not request.json or not 'title' in request.json:

? ? ? ?abort(400)

? ?task = {

? ? ? ?'id': tasks[-1]['id'] + 1,

? ? ? ?'title': request.json['title'],

? ? ? ?'description': request.json.get('description', ""),

? ? ? ?'done': False

? ?}

? ?tasks.append(task)

? ?return jsonify({'task': task}), 201

添加一个新的任务也是相当容易地。只有当请求以 JSON 格式形式，request.json 才会有请求的数据。如果没有数据，或者存在数据但是缺少 title 项，我们将会返回 400，这是表示请求无效。

接着我们会创建一个新的任务字典，使用最后一个任务的 id + 1 作为该任务的 id。我们允许 description 字段缺失，并且假设 done 字段设置成 False。

我们把新的任务添加到我们的任务数组中，并且把新添加的任务和状态 201 响应给客户端。

使用如下的 curl 命令来测试这个新的函数:

$ curl -i -H "Content-Type: application/json" -X POST -d '{"title":"Read a book"}'

HTTP/1.0 201 Created

Content-Type: application/json

Content-Length: 104

Server: Werkzeug/0.8.3 Python/2.7.3

Date: Mon, 20 May 2013 05:56:21 GMT

{

?"task": {

? ?"description": "",

? ?"done": false,

? ?"id": 3,

? ?"title": "Read a book"

?}

}

注意：如果你在 Windows 上并且运行 Cygwin 版本的 curl，上面的命令不会有任何问题。然而，如果你使用原生的 curl，命令会有些不同:

curl -i -H "Content-Type: application/json" -X POST -d "{"""title""":"""Read a book"""}"

当然在完成这个请求后，我们可以得到任务的更新列表:

$ curl -i

HTTP/1.0 200 OK

Content-Type: application/json

Content-Length: 423

Server: Werkzeug/0.8.3 Python/2.7.3

Date: Mon, 20 May 2013 05:57:44 GMT

{

?"tasks": [

? ?{

? ? ?"description": "Milk, Cheese, Pizza, Fruit, Tylenol",

? ? ?"done": false,

? ? ?"id": 1,

? ? ?"title": "Buy groceries"

? ?},

? ?{

? ? ?"description": "Need to find a good Python tutorial on the web",

? ? ?"done": false,

? ? ?"id": 2,

? ? ?"title": "Learn Python"

? ?},

? ?{

? ? ?"description": "",

? ? ?"done": false,

? ? ?"id": 3,

? ? ?"title": "Read a book"

? ?}

?]

}

剩下的两个函数如下所示:

@app.route('/todo/api/v1.0/tasks/int:task_id', methods=['PUT'])def update_task(task_id):

? ?task = filter(lambda t: t['id'] == task_id, tasks)

? ?if len(task) == 0:

? ? ? ?abort(404)

? ?if not request.json:

? ? ? ?abort(400)

? ?if 'title' in request.json and type(request.json['title']) != unicode:

? ? ? ?abort(400)

? ?if 'description' in request.json and type(request.json['description']) is not unicode:

? ? ? ?abort(400)

学Python入门应该先学什么？

学Python应先从Python开发基础部分入手，如学习Python语言介绍、环境安装、 Python基本语法、基本数据类型、 二进制运算、流程控制、 字符编码、文件处理、 数据类型、用户认证、函数、 三级菜单程序、购物车程序开发、 员工信息表开发、内置方法、 递归、迭代器、装饰器、 模块的跨目录导入、 b加密\re正则\logging日志模块、 常用标准库学习、 软件开发规范学习、 计算器程序、 ATM程序开发等，学完这些基本算是入门了

Python该怎么入门?

作为初学者，第一个月的月目标应该是这样的：

熟悉基本概念（变量，条件，列表，循环，函数）

练习超过 30 个编程问题

利用这些概念完成两个项目

熟悉至少 2 个框架

开始使用集成开发环境（IDE），Github，hosting，services 等

整体计划

现在，我们先将月计划细化成周计划。

第一周：熟悉 Python

要积极探索 Python 的使用方法，尽可能多的完成下面这些任务：

第一天：基本概念（4 小时）：print，变量，输入，条件语句

第二天：基本概念（5 小时）：列表，for 循环，while 循环，函数，导入模块

第三天：简单编程问题（5 小时）：交换两个变量值，将摄氏度转换为华氏温度，求数字中各位数之和，判断某数是否为素数，生成随机数，删除列表中的重复项等等

第四天：中级编程问题（6 小时）：反转一个字符串（回文检测），计算最大公约数，合并两个有序数组，猜数字游戏，计算年龄等等

第五天：数据结构（6 小时）：栈，队列，字典，元组，树，链表。

第六天：面向对象编程（OOP）（6 小时）：对象，类，方法和构造函数，面向对象编程之继承

第七天：算法（6 小时）：搜索（线性和二分查找）、排序（冒泡排序、选择排序）、递归函数（阶乘、斐波那契数列）、时间复杂度（线性、二次和常量）

通过第一周时间，python大致能熟悉了，自学能力稍微弱一点找人带下你，节约自己的时间。

注意：别急着安装 Python 环境！

这看起来很矛盾，但是你一定要相信我。我有几个朋友，他们因为语言工具包和 IDE 安装的失败而逐渐失去了学习下去的欲望。因此，我的建议是先使用一些安卓 app 来探索这门语言，如果你是个技术小白，安装 Python 环境可不是你的首要任务。

第二周：开始软件开发（构建项目）

接下来，让我们朝着软件开发任务进军吧！不妨尝试综合你学到的知识完成一个实际的项目：

第一天：熟悉一种 IDE（5 小时）: IDE 是你在编写大型项目时的操作环境，所以你需要精通一个 IDE。在软件开发的初期，我建议你在 VS code 中安装 Python 扩展或使用 Jupyter notebook。

第二天：Github（6 小时）：探索 Github，并创建一个代码仓库。尝试提交（Commit）、查看变更（Diff）和上推（Push）你的代码。另外，还要学习如何利用分支工作，如何合并（merge）不同分支以及如何在一个项目中创建拉取请求（pull request）。

第三天：第一个项目——简单计算器（4 小时）：熟悉 Tkinter，创建一个简单的计算器

第四、五、六天：个人项目（每天 5 小时）：选定一个项目并完成它。如果你不知道你该做什么，可以查看下面的清单（ pythonprojects -for-an- middle - programmer/answer/jhankar - mahbub2）

第七天：托管项目（5 小时）：学习使用服务器和 hosting 服务来托管你的项目。创建一个 Heroku 设置并部署你构建的应用程序。

为什么要写项目？

如果仅仅按部就班地学习课堂上或视频中的内容，你无法拥有独立思考能力。所以，你必须把你的知识应用到一个项目中。当你努力寻找答案时，你也在慢慢地学会这些知识。

第三周：让自己成为一名程序员

第 3 周的目标是熟悉软件开发的整体过程。你不需要掌握所有的知识，但是你应该知道一些常识，因为它们会影响你的日常工作。

第一天：数据库基础（6 小时）：基本 SQL 查询（创建表、选择、Where 查询、更新）、SQL 函数（Avg、Max、Count）、关系数据库（规范化）、内连接、外连接等

第二天：使用 Python 数据库（5 小时）：利用一种数据库框架（SQLite 或 panda），连接到一个数据库，在多个表中创建并插入数据，再从表中读取数据。

第三天：API（5 小时）：如何调用 API。学习 JSON、微服务（micro-service）以及表现层应用程序转换应用程序接口（Rest API）。

第四天：Numpy（4 小时）：熟悉 Numpy（- Numpy -for- datascies-beginners-b8088722309f）并练习前 30 个 Numpy 习题（- 100/blob/master/100_numpy_excercises.md)

第五、六天：作品集网站（一天 5 小时）：学习 Django，使用 Django 构建一个作品集网站（- start-with-django -1/），也要了解一下 Flask 框架。

第七天：单元测试、日志、调试（5 小时）：学习单元测试（PyTest），如何设置和查看日志，以及使用断点调试。

真心话时间（绝密）

如果你非常「疯狂」，并且非常专注，你可以在一个月内完成这些任务。你必须做到：

把学习 Python 作为你的全职活动。你需要从早上 8 点开始学习，一直到下午 5 点。在此期间，你可以有一个午休时间和茶歇时间（共 1 小时）。

8 点列出你今天要学的东西，然后花一个小时复习和练习你昨天学过的东西。

从 9 点到 12 点：开始学习，并进行少量练习。在午饭后，你需要加大练习量，如果你卡在某个问题上，可以在网上搜索解决方案。

严格保持每天 4-5 小时的学习时间和 2-3 小时的练习时间（每周最多可以休息一天）。

你的朋友可能会认为你疯了。走自己的路，让别人去说吧！

如果你有一份全职工作，或者你是一名学生，完成这些流程可能需要更长的时间。作为一名全日制学生，我花了 8 个月的时间来完成这份清单。现在我是一名高级开发人员。所以，不管花多长时间，一定要完成它们。要想成功完成一个目标，必须付出百分之百的努力。

第四周：认真考虑工作（实习）问题

第 4 周的目标是认真思考如何才能被录用。即使你现在不想找工作，你也可以在探索这条道路的过程中学到很多东西。

第一天：准备简历（5 小时）：制作一份一页的简历。把你的技能总结放在最上面，必须在写项目的同时附上 Github 链接。

第二天：作品集网站（6 小时）：写几个博客，将它们添加到你之前开发的作品集网站中。

第三天：LinkedIn 简介（4 小时）：创建一个 LinkedIn 个人简介，把简历上的所有内容都放到 LinkedIn 上。

第四天：面试准备（7 小时）：准备一些谷歌常见的面试问题，练习白皮书中的 10 个面试编程问题。在 Glassdoor、Careercup 等网站中查看前人遇到的面试问题。

第五天：社交（~小时）：走出房门，开始参加聚会、招聘会，与其他开发人员和招聘人员见面。

第六天：工作申请（~小时）：搜索「Python Job」，查看 LinkedIn Job 和本地求职网站。选择 3 个工作岗位并发送工作申请。为每个工作定制你的简历。在每个工作要求中找出 2 到 3 件你不知道的事情，并在接下来的 3-4 天里学会它们。

第七天：在拒绝中学习（~小时）：每次你被拒绝的时候，找出两件为了获得这份工作你应该知道的事情，然后花 4-5 天 的时间来掌握它们。这样，每次拒绝都会让你成为更好的开发人员。