网页设计公司婚庆网站模板下载,一个网站做多访问量,郑州网络推广广告公司,设计方案汇报设计接口应该考虑的因素#xff1a; 接口的业务定位 接口的安全性 接口的可扩展性 接口的稳定性 接口的跨域性 接口的协议规则 接口的路径规则 接口单一原则 接口过滤及接口组合
1.职责原则
在设计接口时#xff0c;必须明确接口的职责#xff0c;即接口类型 接口的业务定位 接口的安全性 接口的可扩展性 接口的稳定性 接口的跨域性 接口的协议规则 接口的路径规则 接口单一原则 接口过滤及接口组合
1.职责原则
在设计接口时必须明确接口的职责即接口类型接口应解决什么业务问题等
2.单一性原则
在明确接口职责的条件下尽量做到接口单一即一个接口只做一件事而非两件以上。
很多非资深接口设计者在设计接口时总认为接口所做的事越多越牛叉这是非常严重的错误认识。
3.协议规范
在设计接口时应明确接口协议是采用HTTP协议,HTTPS协议还是FTP协议要根据具体情况来定。
(1)FTP协议(File Transfer Protocol简称FTP)是一套标准的文件传输协议用于传输文件如.txt.csv等一般文件传输采用FTP协议
(2)HTTP协议适用一般对安全性要求比较低或没要求的业务情景
(3)HTTPSHTTPSSL,适用于对安全性要求较高的业务情景
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.可扩展性原则
在设计接口时充分考虑接口的可扩展性。
