# DRF
## 1.REST的基本使用
#### 1.介绍:
**在前后端分离的应用模式里,API接口如何定义?**
例如对于后端数据库中保存了商品的信息,前端可能需要对商品数据进行增删改查,那相应的每个操作后端都需要提供一个API接口:
1. POST /add-goods 增加商品
2. POST /delete-goods 删除商品
3. POST /update-goods 修改商品
4. GET /get-goods 查询商品信息
对于接口的请求方式与路径,每个后端开发人员可能都有自己的定义方式,风格迥异。
是否存在一种统一的定义方式,被广大开发人员接受认可的方式呢?
这就是被普遍采用的API的RESTful设计风格。
商业模式:
b2c:企业销售给个人--京东
c2c:个人销售给个人--淘宝
020:线上到线下--美团饿了么
b2b:企业销售给企业--慧聪网
#### RESTful设计方法
###### 1. 域名
应该尽量将API部署在专用域名之下。
```http
https://api.example.com
```
如京东 京东关于手机的域名为shouji.jd.com 其所有的手机都在这个域名下
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
```http
https://example.org/api/
```
###### 2. 版本
应该将API的版本号放入URL。
```http
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
```
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。[Github](https://developer.github.com/v3/media/#request-specific-version)采用这种做法。
因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分(参见[Versioning REST Services](http://www.informit.com/articles/article.aspx?p=1566460)):
```http
Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
```
###### 3. 路径
路径又称"终点"(endpoint),表示API的具体网址,每个网址代表一种资源(resource)
**(1) 资源作为网址,只能有名词,不能有动词,而且所用的名词往往与数据库的表名对应。**
举例来说,以下是不好的例子:
```http
/getProducts
/listOrders
/retreiveClientByOrder?orderId=1
```
对于一个简洁结构,你应该始终用名词**复数**。 此外,利用的HTTP方法可以分离网址中的资源名称的操作。
```http
GET /products :将返回所有产品清单
POST /products :将产品新建到集合
GET /products/4 :将获取产品 4
PATCH(或)PUT /products/4 :将更新产品 4
```
**(2) API中的名词应该使用复数。无论子资源或者所有资源。**
举例来说,获取产品的API可以这样定义
```http
获取单个产品:http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products
```
(3)对于具体是何种操作,由请求方式决定
###### 3. HTTP动词
对于资源的具体操作类型,由HTTP动词表示。
常用的HTTP动词有下面四个(括号里是对应的SQL命令)。
- GET(SELECT):从服务器取出资源(一项或多项)。
- POST(CREATE):在服务器新建一个资源。
- PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
- DELETE(DELETE):从服务器删除资源。
还有三个不常用的HTTP动词。
- PATCH(UPDATE):在服务器更新(更新)资源(客户端提供改变的属性)。
- HEAD:获取资源的元数据。
- OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。
下面是一些例子。
```http
GET /zoos:列出所有动物园
POST /zoos:新建一个动物园(上传文件)
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物
```
###### 4. 过滤信息
即 查询参数
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。
```http
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?animal_type_id=1:指定筛选条件
```
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
###### 6.状态码
服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
> - 200 OK - [GET]:服务器成功返回用户请求的数据
> - 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
> - 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
> - 204 NO CONTENT - [DELETE]:用户删除数据成功。
> - 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作
> - 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
> - 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
> - 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
> - 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
> - 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
> - 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
> - 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
状态码的完全列表参见[这里](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)或[这里](https://zh.wikipedia.org/wiki/HTTP%E7%8A%B6%E6%80%81%E7%A0%81)。
###### 7. 错误处理
如果状态码是4xx,服务器就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。
```json
{
error: "Invalid API key"
}
```
###### 8. 返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范。
- GET /collection:返回资源对象的列表(数组)
- GET /collection/resource:返回单个资源对象
- POST /collection:返回新生成的资源对象
- PUT /collection/resource:返回完整的资源对象
- PATCH /collection/resource:返回完整的资源对象
- DELETE /collection/resource:返回一个空文档
###### 9. 其他
服务器返回的数据格式,应该尽量使用JSON,避免使用XML
### 使用Django开发REST 接口
##### 1.接口设计
对于过滤条件 通过在路径中添加查询参数 如:books?page=1&limit= 10
**路由匹配**
对于路由的匹配,由请求路径可以得出,分为带id的和不带id的两种,所以写路由时可以写2个路由 分别是 book 和books
**增加图书**:
增加图书是增加某一本图书 所有需要传递路径参数
```bash
请求方式:post
请求路径:books/
请求参数:根据模型类需要的值进行传递,对于有默认值的数据可以不传递
请求参数:json
过滤信息以查询字符串传递
返回结果:保存后的图书数据
```
**修改图书**
```
请求方式 PUT
请求路径 books/1
请求参数 btitle(修改的内容) json. Id 路径
返回结果 更新后的图书数据。book={btitle:'西游记'}
```
**查询图书**
```
查询单一图书
请求方式 GET
请求路径 books/1
请求参数 Id 路径
返回结果 book={btitle:'西游记'}
```
查询所有图书
```
请求方式 GET
请求路径 books/
请求参数
返回结果 books=[{btitle:'西游记'},{btitle:'射雕英雄传'}]. 数组
```
惰性执行 缓存操作
http.json(safe = False)----默认不接受数组,需要改变接收类型
我们以在Django框架中使用的图书英雄案例来写一套支持图书数据增删改查的REST API接口,来理解REST API的开发。
在此案例中,前后端均发送JSON格式数据。
```python
# views.py
from datetime import datetime
class BooksAPIVIew(View):
"""
查询所有图书、增加图书
"""
def get(self, request):
"""
查询所有图书
路由:GET /books/
"""
queryset = BookInfo.objects.all()
book_list = []
for book in queryset:
book_list.append({
'id': book.id,
'btitle': book.btitle,
'bpub_date': book.bpub_date,
'bread': book.bread,
'bcomment': book.bcomment,
'image': book.image.url if book.image else ''
})
return JsonResponse(book_list, safe=False)
def post(self, request):
"""
新增图书
路由:POST /books/
"""
json_bytes = request.body
json_str = json_bytes.decode()
book_dict = json.loads(json_str)
# 此处详细的校验参数省略
book = BookInfo.objects.create(
btitle=book_dict.get('btitle'),
bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date()
)
return JsonResponse({
'id': book.id,
'btitle': book.btitle,
'bpub_date': book.bpub_date,
'bread': book.bread,
'bcomment': book.bcomment,
'image': book.image.url if book.image else ''
}, status=201)
class BookAPIView(View):
def get(self, request, pk):
"""
获取单个图书信息
路由: GET /books/<pk>/
"""
try:
book = BookInfo.objects.get(pk=pk)
except BookInfo.DoesNotExist:
return HttpResponse(status=404)
return JsonResponse({
'id': book.id,
'btitle': book.btitle,
'bpub_date': book.bpub_date,
'bread': book.bread,
'bcomment': book.bcomment,
'image': book.image.url if book.image else ''
})
def put(self, request, pk):
"""
修改图书信息
路由: PUT /books/<pk>
"""
try:
book = BookInfo.objects.get(pk=pk)
except BookInfo.DoesNotExist:
return HttpResponse(status=404)
json_bytes = request.body
json_str = json_bytes.decode()
book_dict = json.loads(json_str)
# 此处详细的校验参数省略
book.btitle = book_dict.get('btitle')
book.bpub_date = datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date()
book.save()
return JsonResponse({
'id': book.id,
'btitle': book.btitle,
'bpub_date': book.bpub_date,
'bread': book.bread,
'bcomment': book.bcomment,
'image': book.image.url if book.image else ''
})
def delete(self, request, pk):
"""
删除图书
路由: DELETE /books/<pk>/
"""
try:
book = BookInfo.objects.get(pk=pk)
except BookInfo.DoesNotExist:
return HttpResponse(status=404)
book.delete()
return HttpResponse(status=204)
# urls.py
urlpatterns = [
url(r'^books/$', views.BooksAPIVIew.as_view()),
url(r'^books/(?P<pk>\d+)/$', views.BookAPIView.as_view())
]
```
#### 测试
使用Postman测试上述接口
1) 获取所有图书数据
GET 方式访问 <http://127.0.0.1:8000/books/,> 返回状态码200,数据如下
```json
[
{
"id": 1,
"btitle": "射雕英雄传",
"bpub_date": "1980-05-01",
"bread": 12,
"bcomment": 34,
"image": ""
},
{
"id": 2,
"btitle": "天龙八部",
"bpub_date": "1986-07-24",
"bread": 36,
"bcomment": 40,
"image": ""
},
{
"id": 3,
"btitle": "笑傲江湖",
"bpub_date": "1995-12-24",
"bread": 20,
"bcomment": 80,
"image": ""
},
{
"id": 4,
"btitle": "雪山飞狐",
"bpub_date": "1987-11-11",
"bread": 58,
"bcomment": 24,
"image": ""
},
{
"id": 5,
"btitle": "西游记",
"bpub_date": "1988-01-01",
"bread": 10,
"bcomment": 10,
"image": "booktest/xiyouji.png"
},
{
"id": 6,
"btitle": "水浒传",
"bpub_date": "1992-01-01",
"bread": 10,
"bcomment": 11,
"image": ""
},
{
"id": 7,
"btitle": "红楼梦",
"bpub_date": "1990-01-01",
"bread": 0,
"bcomment": 0,
"image": ""
}
]
```
2)获取单一图书数据
GET 访问 <http://127.0.0.1:8000/books/5/> ,返回状态码200, 数据如下
```json
{
"id": 5,
"btitle": "西游记",
"bpub_date": "1988-01-01",
"bread": 10,
"bcomment": 10,
"image": "booktest/xiyouji.png"
}
```
GET 访问<http://127.0.0.1:8000/books/100/,返回状态码404>
3)新增图书数据
POST 访问<http://127.0.0.1:8000/books/,发送JSON数据:>
```json
{
"btitle": "三国演义",
"bpub_date": "1990-02-03"
}
```
返回状态码201,数据如下
```json
{
"id": 8,
"btitle": "三国演义",
"bpub_date": "1990-02-03",
"bread": 0,
"bcomment": 0,
"image": ""
}
```
4)修改图书数据
PUT 访问<http://127.0.0.1:8000/books/8/,发送JSON数据:>
```json
{
"btitle": "三国演义(第二版)",
"bpub_date": "1990-02-03"
}
```
返回状态码200,数据如下
```json
{
"id": 8,
"btitle": "三国演义(第二版)",
"bpub_date": "1990-02-03",
"bread": 0,
"bcomment": 0,
"image": ""
}
```
5)删除图书数据
DELETE 访问<http://127.0.0.1:8000/books/8/,返回204状态码> |
|