Restful,9大规范

Restful是web API 的一种规范!
用例:dingo/api

9大规范

  1. API与用户的通信协议,用HTTPS
  2. 命名规范:https://api.xx.com或https://xx.com/api
  3. 版本规范:

    https://xx.com/api/v1
    https://xx.com/api/v2
  4. 数据即资源
    https://xx.com/api/v1/book
    https://xx.com/api/v1/books
  5. 不同的method控制不同的操作
    GET:https://xx.com/api/v1/books 列表资源
    GET:https://xx.com/api/v1/books/1 一个资源
    POST:https://xx.com/api/v1/books 新增资源,返回相应资源
    PUT:https://xx.com/api/v1/books 编辑资源全部信息,返回相应资源
    PATCH:https://xx.com/api/v1/books 编辑资源部分信息,返回相应资源
    DELETE:https://xx.com/api/v1/books 删除资源,返回空
  6. 过滤:
    https://xx.com/api/v1/books?limit=10:指定返回记录的数量
  7. 状态码:

    200-成功,201-创建成功
    301-永久重定向,302-暂时重定向
    403-请求无权限,404-请求路径不存在,405-请求方法不存在
    参考HTTP/1.1: Status Code Definitions
  8. 返回code,message
    {
        code:0,
        message:''
    }
  9. 结果返回,可以是全链接
    {
        code:0,
        message:'success',
        data:{
            url:'https://www.xx.com/111.png'
        }
    }

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值