接口(API)开发应该遵循的原则

2023-06-03 0 265

准则

准则形成内部结构设计要达至的计算方法,最差课堂教学提供更多如前所述以后的策尔纳出来的提示和商业模式。

1. 统计数据源驱动力

如前所述统计数据和机能的USB如果如前所述较好定义的统计数据源、基本概念和名词。USB对内曝露的如果是统计数据第一类/它代表者的基本概念的数学模型而并非下层控制系统。

总括:HR 主统计数据 API 对内曝露的统计数据源如果由负责管理 API 的商品项目组来内部结构设计和策画。这些统计数据源代表者的是组织机构自己认知的 HR 名词、虚拟和销售业务流程,而并非下层的控制系统(比如说 SAP HR 或是 Workday 之类)。

前述负面影响

在开始构筑 API 以后,商品项目组须要在 API 技术国际标准表明中表述下层统计数据源的文档。这须要知道怎样内部结构设计 API 的技师和认知销售业务的统计数据、销售业务流程语句的有关主轴的研究者一同协力。API 技术国际标准表明是与自身利益有关人探讨 API 覆盖范围和内部结构的主要文件文件格式。

2. 以技术国际标准表明为参照计算方法

如前所述通用型、对外开放国际标准和技术国际标准表明(比如 OpenAPI、触发器API、JSON Schema)来构筑 API,进而确保 API 的低熵值,并可以通过通用型词语来认知它。

前述负面影响

从该准则来检视 API 不然,一个好的 API 如果是:

如果是并行的,如前所述 OpenAPI 国际标准。统计数据传输文件格式是 JSON如前所述 JSON Schema 构筑或是手动聚合 Schema

3. 如前所述合约

API 须要表述较好的合约和服务项目水平协议。它代表者了提供更多平衡、可信和安全可靠服务项目的允诺,因此要考虑到服务项目顾客的最小自身利益。

前述负面影响

从该准则来检视 API,一个好的 API 如果具有如下特点:

文件文件格式化的服务项目水平协定(SLA)。这样,用户才能知道该从 API 有什么样的期待进而做相应的内部结构设计。版本控制。API 的构筑和部署时刻考虑到版本控制。这样,API 仍然支持被访问的方式随着时间产生变化,但是是以一种须要 API 的用户从他们一侧采取有意和得用户验证数学模型因此使质量确保和手动化测试变得可行。可以随时废弃 API 或是数学模型。废弃机能表明你建议用户一个升级路径,但是不强制他们要这样做。对于已废弃的USB和数学模型,用户不能期望任何新的特性。关键接口不能强制用户升级到新的版本。通过监控 API,你可以跟踪每个 API 和数学模型的版本被使用的流量,当所有用户都升级或是迁移到新的 API 后,旧的 API 就可以被移除了。

4. 全球可用

对于跨国性质的销售业务提供更多支持的服务项目,须要时刻考虑全球可用性和可访问性。

5. 为公开消费而内部结构设计

多数 API 会对内曝露敏感的机能和统计数据,所以当服务项目曝露在对外开放的因特网上时,就须要内部结构设计和构筑 API 的安全可靠性,这毋庸置疑;但是,即使没有对对外开放因特网公开,我们也要当作已经公开一样来对待。

6. 可发现的

API 总是为其他商品项目组或是领域来消费而构筑,所以须要通过一个集中化的 API 门户,把它构筑成可发现的和可用的。

接口(API)开发应该遵循的原则
Jeff Tian
49 次咨询
5.0
复旦大学 工程硕士
2878 次赞成
去咨询

相关文章

发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务