restful规范整理

时间:2023-03-08 15:44:51

restful的十条规范

  restful一共有十条规范,但其并不是规定。可以不去遵守,是一种软件风格

  1.API与客户端交互,通常使用https协议

  2.域名:https://api.baidu.com(需要解决跨域问题)  或   https://www.baidu.com/api/

  3.版本:在域名后加版本名,低版本可以逐渐迁移到高版本

  4.路径:视网络上的任何东西都为资源,均使用名词来表示

  5.method来表示增删改查

  6.过滤:通过url上传参数的形式来传递搜索条件

  7.状态码:例如:{‘status’:100}

  8.错误处理应该返回错误信息  例如:{‘status’:101,‘error’:‘错误’}

  9.返回结果中提供链接   例如:{

                id:1,

                name:xxxx,

                price:12

                publish:www.baidu.com/api/

                }

  10.返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范:

    GET/collection:返回资源对象的列表(数组)

    GET/collection/resource:返回单个资源对象

    POST/collection:返回新生成的资源对象

    PUT/collestion/resource:返回完整资源对象

    PATCH/collestion/resource:返回完整资源对象

    DELETE/collection/resource:返回一个空文档

皮一下,编程要有规范,社会才美好!!!  如有不对的地方,欢迎各位指教,谢谢!~