• 设计接口应该考虑的因素以及遵循的原则


    设计接口应该考虑的因素:

    • 接口的业务定位

    • 接口的安全性

    • 接口的可扩展性

    • 接口的稳定性

    • 接口的跨域性

    • 接口的协议规则

    • 接口的路径规则

    • 接口单一原则

    • 接口过滤及接口组合

    1.职责原则

    在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等

    2.单一性原则

    在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件以上。

    很多非资深接口设计者,在设计接口时,总认为接口所做的事越多,越牛叉,这是非常严重的错误认识。

    3.协议规范

    在设计接口时,应明确接口协议,是采用HTTP协议,HTTPS协议还是FTP协议,要根据具体情况来定。

    (1)FTP协议(File Transfer Protocol,简称FTP),是一套标准的文件传输协议,用于传输文件,如.txt,.csv等,一般文件传输,采用FTP协议

    (2)HTTP协议,适用一般对安全性要求比较低或没要求的业务情景

    (3)HTTPS=HTTP+SSL,适用于对安全性要求较高的业务情景

    4.路径规则

    由于api获取的是一种资源,所以网址中尽量为名词,而非动词

     /api/v1.0/Product/2023

    /api/v1.0/Users/2023

    5.http请求方式

    接口基本访问协议:get(获取),post(新增),put(修改)和delete(删除)

    get     /users:列出所有用户

    get    /users/id:根据id获取用户

    post   /user:新增用户

    put      /user/id:根据用户id更新用户

    delete   /user/id:根据用户id删除用户

    6.域名

    一般地,域名分为主域名和专有域名,主域名适合api长期不变或变化较少的业务,专有域名是解决具体的专有业务的

    7.跨域考虑

    在明确域名的情况下,一定要考虑接口是否跨域,以及跨域应采用的技术手段等

    8.api版本

    对于接口的url,应加版本号http://api.demo.com/v{d}/,如 ,其中d表示版本号,如v1.0,v2.0

    9.安全性原则

    接口暴露的考虑,接口并发量的考虑,接口防攻击的考虑,接口跨域的考虑等

    10.可扩展性原则

    在设计接口时,充分考虑接口的可扩展性。

  • 相关阅读:
    csdn 格式规范
    滑动窗口和螺旋矩阵
    Python 多线程HTTP服务器
    不同类型的物联网产品、物联网产品的优势
    【Android工具】群晖安卓客户端基础套件:Drive、video、Photos和DS video安卓TV客户端...
    Qt安卓开发经验技巧总结V202308
    数据库基础
    就想了解服务器为什么1M带宽网速却达不到1M
    android HAL 执行权限写法
    【计算机网络】网络层(四)—— 网络层协议总结(ARP、ICMP、IGMP)
  • 原文地址:https://blog.csdn.net/weixin_41648325/article/details/133770524