31
2021
01

什么是restful规范

 restful规范是一套规则,用于API中之间进行数据交换的约定。

 它的具体规则有:

 1、https代替http,保证数据传输时的安全

 2、在url中一般要体现api标识,这样看到url就知道他是一个api

     建议:https://www.zdr.com/api/...(不会存在跨域问题)

 3、在接口中要体现版本,可放在url中也可以放在请求头中

     建议:https://www.zdr.com/api/v1/...

 4、restful也称为面向资源编程,视网络上的一切都是资源,对资源可以进行操作,所以一般资源都用名词

 5、如果要加入一些筛选条件,可以添加在url中

     https://www.zdr.com/api/v1/user/?page=1&type=9

 6、根据method请求方法不同做不同操作

     get/post/put/patch/delete

 7、根据请求方法不同返回不同的值

     get全部/post返回添加的值/put/patch/delete不返回值

 8、给用户返回状态码

     - 200——成功

     - 300——301是永久重定向,302是临时重定向

     - 400——403拒绝中间件的csrftoken认证 /404找不到

     - 500——服务端代码错误

 9、操作异常时,要返回错误信息

     {

         error: "Invalid API key"

     }

 10、对于下一个请求要返回一些接口: Hypermedia AP

     {

         'id':2,

         'name':'alex',

         'age':19,

         'depart': "http://www.luffycity.com/api/user/30/"

     }


« 上一篇 下一篇 »

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。