基于 Flask 的 Web API 开发指南 v2.0

<h1>基于 Flask 的 Web API 开发指<span id="blink">南</span> <div class="corner-ribbon top-right sticky orange">v2.0</div></h1>

李辉（Grey Li） 🐍 PyCon China 2019 成都

---

## 演讲录像

- [bilibili](https://www.bilibili.com/video/av75168852/)
- [YouTube](https://youtu.be/Fz5Zq4WM_c0)

## 上海站 1.0 版本

- [幻灯片](http://greyli.com/slides/pyconchina2019-api/v1)
- 录像暂无

---

## 李辉 / Grey Li

- 野生程序员
- [Flask](https://github.com/pallets/flask) 维护者之一
- 《[Flask Web 开发实战](http://helloflask.com/book/)》作者
- [HelloFlask](http://helloflask.com) 管理员
- 个人网站 [greyli.com](http://greyli.com)

---
class: center, middle

# 听众调查时间 📃

---

## 四分钟入门 Flask 和 Web API 开发

---

## 一分钟认识 Flask

- 短定义：一个 Python Web 微框架

- 长定义：一个主要基于 Werkzeug 和 Jinja 的轻量 WSGI Web 程序框架

- 无术语：一个帮助你更方便开发 Web 程序/动态网站的工具，只内置了一些基础功能，其他的功能都要通过扩展来实现

- 列表：
    - Web 微框架（Web development, one drop at a time）
    - 微核心（Werkzeug + Jinja2）+易于扩展（第三方扩展）
    - 自由灵活，更 Pythonic

- 图：

---

## 一分钟入门 Flask 开发

install
```bash
$ pip install flask
```

code
```python
# app.py
from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello():
    return 'Hello, <a href="https://cn.pycon.org">PyCon China</a>!'
```

run
```bash
$ flask run
 ...
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
```

---

---

## 一分钟认识 Web API

- 短定义：JSON/XML over HTTP

- 长定义：可以使用 HTTP 协议进行访问，返回 XML 或 JSON 格式数据的 API

- 无术语：给机器/程序使用，通过网络访问，返回 JSON 或 XML 格式纯数据的接口。

- 列表：
    - 可以使用 HTTP 访问的 URL 数据集合
    - 返回 JSON 或 XML 格式的纯数据
    - 使用 URL 描述数据
    - 使用不同的 HTTP 方法表示不同的操作

- 图：<img src="./images/api-fake.png">

---

---

## 一分钟入门 Web API 开发

code
```python
# app.py
from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello():
    return {
        'message': 'Hello, PyCon China!',
        'url': 'https://cn.pycon.org'
    }
```

run
```bash
$ flask run
 ...
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
```

---

## 一分钟入门 Web API 开发

code
```python
# app.py
from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello():
*   return {
*       'message': 'Hello, PyCon China!',
*       'url': 'https://cn.pycon.org'
*   }
```

run
```bash
$ flask run
 ...
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
```

---

## 一分钟入门 Web API 开发

install [HTTPie](https://httpie.org/)
```bash
$ pip install httpie
```

test
```bash
$ http get :5000
HTTP/1.0 200 OK
Content-Length: 54
Content-Type: application/json
Date: Tue, 17 Sep 2019 01:10:24 GMT
Server: Werkzeug/0.15.6 Python/3.6.8

{
    "message": "Hello, PyCon China!",
    "url": "https://cn.pycon.org"
}
```

---

## 一分钟入门 Web API 开发

install [HTTPie](https://httpie.org/)
```bash
$ pip install httpie
```

test
```bash
$ http get :5000
HTTP/1.0 200 OK
Content-Length: 54
*Content-Type: application/json
Date: Tue, 17 Sep 2019 01:10:24 GMT
Server: Werkzeug/0.15.6 Python/3.6.8

*{
*   "message": "Hello, PyCon China!",
*   "url": "https://cn.pycon.org"
*}
```

---

## 参加 PyCon China 的收获 +1

<h3 class="blur">李明明 后端工程师</h3>

<ul class="blur">
    <li>- 精通 Python、PHP、Java 等语言</li>
    <li>- 写过操作系统和编译器</li>
    <li>- 有亿万级高并发项目开发经验</li>
    <li>- 不用鼠标，不用 IDE，不用 Windows</li>
</ul>
<p>
<span style="background: #bef5cb; padding: 10px"> +</span><span style="background: #cdffd8; padding: 10px 20px">- 了解 Flask 框架和 Web API</span>
</p>
<p>

<span style="background: #bef5cb; padding: 10px"> +</span><span style="background: #cdffd8; padding: 10px 20px">- 能够使用 Flask 进行 Web API 开发</span>

</p>
</div>

---
class: middle, center, inverse

# Web API 术语梳理

---

### Flask 使用 cookie 而不是 session 存储 session 信息。在处理 cookie 的时候，Flask 会把存储到 session 的 session 信息加密后放到 session cookie 里。🤔

---

## session 四重奏

1. 用户会话（常规语境）
2. 在服务器端存储用户会话的认证实现方法（用户认证语境）
3. Flask 提供的全局变量的名字（Flask 语境）
4. 一块 Cookie 的键（Flask 实现用户认证语境）

<hr>

Flask 使用 cookie 而不是 **session**（2） 存储 **session**（1） 信息。在处理 cookie 的时候，Flask 会把存储到 **session**（3） 的 **session**（1） 信息加密后放到 **session**（4） cookie 里。

---

## 术语梳理的方式

- 尽量使用英文形式
- 尽量使用正确的术语
- 了解这个术语的英文形式、含义和来源
- 了解某一个术语在不同语境下的不同含义
- 了解某个术语相关的术语，了解这些术语之间的关联和区别

---

## 使用 HTTP 协议通过网络调用的 API

- API / API 接口

.footnote[
- https://en.wikipedia.org/wiki/Application_programming_interface
- https://en.wikipedia.org/wiki/Microservices
- https://en.wikipedia.org/wiki/Representational_state_transfer
- https://en.wikipedia.org/wiki/Web_service
- https://en.wikipedia.org/wiki/Web_API

]

- 微服务（Microservices）

- REST API / RESTful API

- Web 服务（Web Service）

- Web API 🎈

---

## 资源、端点和首部

- 资源（Resources）
- = 数据（Data）

- 端点（Endpoint）
    - = URI（Uniform Resource **Identifier**）：URL 和 URN 的父集 🎈
    - = URL（Uniform Resource **Locator**）：URI 的最常见形式 🎈
    - URN（Uniform Resource **Name**）：URI 的不常见形式
    - 网址（Website address）：http:// helloflask.com
    - 超链接/链接（Hyperlink/Link）：[HelloFlask](http://helloflask.com)

- HTTP 首部（Header）
    - = 首部
    - = 头部
    - 首部字段：首部中包含的某些信息

---

## 请求和响应处理