Loading

drf入门规范

web应用模式

在web应用中,有两种应用模式:

1、前后端混合

前后端不分离

3、前后端分离

img

API接口

为了在团队内部形成统一的规范,防止个人习惯差异引起的混乱,我们需要找到一种大家都觉得很好的接口实现,而且这种规范能够让后端写的接口,用途一目了然,减少双方之间的合作成本。

通过网络,规定了前后台信息交互规则的url连接,也就是前后台信息交互的媒介

Web API接口和一般的url连接还是有区别的,Web API接口简单概括有下面四大特点:

  • url:长得像返回数据的url连接
  • 请求方式:get,post,put,patch,delete
    • 采用get方式请求上方接口
  • 请求参数:json或xml格式的key-value类型数据
    • ak:6E823f587c95f0148c19993539b99295
    • region:上海
    • query:肯德基
    • output:json
  • 响应结果:json或xml格式的数据
    • 上方请求参数的output参数值决定了响应数据的格式
    • 数据
# xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
    "status":0,
  	"message":"ok",
    "results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

接口测试工具:Postman、apizza

https://www.getpostman.com/downloads/

http://www.apizza.net/

RESTful API规范

REST全称是Representational State Transfer,中文意思是表述(编者注:通常译为表征性状态转移)。它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的,对外提供的是数据资源的访问接口,所以在定义接口时,客户端访问的URL路径就表示这种要操作的数据资源。

事实上,我们可以使用任何一个框架都可以实现符合restful规范的API接口。

1、使用HTTPS协议

url链接一般都采用HTTPS协议进行传输,可以提高数据交互过程中的安全性。

2、路径中带api标识

用api关键字标识接口url:

看到api字眼,就代表该请求url链接是完成前后台数据交互的。

3、路径中带版本

在url链接中标识数据库版本:

4、尽量使用名词(可复数)

接口一般都是完成前后台数据的交互,交互的数据我们称之为资源

一般提倡用资源的复数形式,在url链接中尽量不要出现操作资源的动词,错误示范:https://api.baidu.com/delete-user

特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义:

5、通过请求方式决定操作(method)

操作资源一般都会涉及到增删改查,我们通过请求方式来标识增删改查动作:

6、url带查询条件

7、返回带响应状态码

7.1、正常响应2XX

  • 200:常规请求
  • 201:创建成功

7.2重定向响应3XX

  • 301:永久重定向
  • 302:暂时重定向

7.3客户端异常4XX

  • 403:请求无权限
  • 404:请求路径不存在
  • 405:请求方法不存在

7.4服务器异常5XX

  • 500:服务器内部异常

8、返回中带错误信息,error当做key

{error: "无操作权限"}

9、返还结果,针对不同操作,服务器向用户返还的结果应该符合以下规范

GET /collection:返还资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

10、响应结果带链接

# Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

比较好的接口返回

# 响应数据要有状态码、状态信息以及数据本身
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(罗餐厅)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月罗路2380号",
            "province":"上海市",
            "city":"上海市",
            "area":"宝山区",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}
posted @ 2021-04-20 15:13  吃了好多肉  阅读(103)  评论(0编辑  收藏  举报