文档结构  
翻译进度:已翻译     翻译赏金:0 元 (?)    ¥ 我要打赏

最近,我有一次关于应该把API定义放在工作首位还是把API设计放在首位的谈话。在API生命周期中哪个应该更早? 结论是将API定义放在第一位,因为在进行API设计时,你需要一组通用的API定义。比如你需要HTTP和HTTP / 2的定义。2017年,你可能会使用到OpenAPI定义规范和JSON模式,这些定义能够帮助您在API设计过程定下基调。

在我看来,在Web上进行设计、开发和运行API的最大好处之一是,开发者被迫抬头关注其他人在做什么,想要什么,而我正在做的就是这样的事。做Web API,提供我自己的API和使用第三方API,都迫使我集中精力去关注API提供者和使用者, 这是非常好的。

第 1 段(可获 1.93 积分)

Image title

通用定义通过利用共同的概念、标准和模式来帮助我们提升API的设计。每次使用ISO8601的时候,你都必须考虑其他时区的人。每次使用ISO4217的时候,你都必须考虑到那些使用不同的货币来进行购买和销售他们的产品和服务的人。当你使用Schema.org的时候,你应该考虑到你的邮政地址的使用范围可能会超出美国,并且考虑使用全球性的商业网络。

我在我的API研究清单中将API的定义放在设计之前,但事实上,我认为这是一个循环。通用定义驱动了我的设计过程,然后在设计中我获取到了更多的经验,并且使我的API定义工具箱更加健壮。最终,这都取决于我所说的定义---但在这个故事里,我认为web框架应该放在定义的首位,而使用OpenAPI定义规范还是JSON schema规范则放在第二位。定义影响了我的设计过程,设计过程又精炼了我的定义,而这正是我在工作中所遵循的。

第 2 段(可获 2.41 积分)

文章评论