语义非常重要,设计 API 时词语的含义至关重要。选择错误的词语,人们可能无法理解您的意图,API 应该做什么,应该提供什么价值或他们可以使用返回的数据做什么。
最后,也是最重要的 3 个中的最后一个:一致性。设计一个一致的 API 很困难,但值得付出代价。与世界其他地方保持一致将使开发人员在第一次看到您的 API 时感到宾至如归。在您的 API 之间以及 API 内部保持一致将使开发人员能够轻松地在操作、数据模型或参数之间建立联系,因此他们将能够掌握您的 API,而无需多加思考。
API 设计评审可以基于事实,而不是意见吗?这可能吗?
是的。这并不总是那么容易,但这就是我试图做的。基于无根据意见的 API 设计评审毫无意义。人们不在乎你是否喜欢蓝色胜过橙色。问题是,在特定情况下,为什么蓝色比橙色更好。所有提出的内容都必须有合理的解释、事实支持。
API 服务条款:从 Creative commons 到机器可读性 – Célya Gruson-Daniel, COSTECH & Mehdi Medjaoui:我是一个“机器可读性狂热者”,我喜欢这种尝试对非结构化数据进行结构化的想法,因为它简化了机器和人类的工作。将机器可读性引入 TOS 对我来说可能会产生重大影响。它可以简化服务提供者之间的比较;作为参与招标流程以选择软件解决方案的人员,我对此非常满意。我相信还有其他完全疯狂的结果。我迫不及待地想参加这个!
寻找衡量 API 设计复杂性的方法 – Stephen Mizell, API 顾问:我帮助人们设计 API,我设计 API。评估设计是否复杂并不总是容易。有时它感觉很复杂或很简单,我不喜欢这样,只是依赖于无根据的感觉。我宁愿用更具体的东西来支持我的评估,如果可能的话,是真实的事实。这就是为什么我非常期待 Stephen 对这个主题的见解。
API 规范评审中要避免的错误 – Rahul Dighe, PayPal:我已经进行了数百次 API 设计评审。我学到了很多,找到了各种情况的解决方案,但有时它们不起作用,或者我可能会遇到完全新的情况。这就是为什么我总是乐于学习其他人所做的事情,因为他们可能找到了相同问题的其他解决方案,或者处于完全不同的环境中,面临着不同的情况。
为了了解更多关于 ASC 2021 的信息,我们与 Mandy Whaley 进行了交流,他是 Microsoft Azure Developer Tools 的产品合作伙伴总监。Whaley 是一位终身软件开发人员,曾在各种规模和类型的开发团队中工作。她在微软领导的团队构建了 Microsoft Azure SDK、Visual Studio 和 VS Code 的 Azure 开发工具,并与公司各部门合作进行 API 设计和开发人员体验。Whaley 将在 ASC 2021 上发表主题演讲,她很好地体现了每年来参加 ASC 并参与其中的那些技能精湛、经验丰富且最重要的是可接触的类型的人。
2021 年 API 开发中最大的问题是什么?
目前最大的挑战是开发速度需求与设计和构建一致、易于使用、持久稳定 API 的需求之间的紧张关系。这是一个平衡行为。
当然,这不是一个新问题,但 API 现在存在于比以往任何时候都多的层级和位置。这意味着有更多团队参与,以及更多的依赖关系。以结果为导向、以客户为中心的 API 设计,由帮助团队了解开发人员实际如何使用 API 的工具提供支持,这一点至关重要。
许多 API 开发团队也面临着与规模、限流、安全性和长时间运行操作相关的挑战。这些都是 API 社区有机会定义模式和实践的领域,这些模式和实践将帮助 API 生产者和消费者。
一年后、三年后 API 开发将有何不同?
API 正在成为每个团队构建软件的核心部分。随着越来越多的团队采用微服务,以及越来越多的公司依赖内部和公共 API 来完成业务的核心部分,我们看到了这一点。我们构建的 API 类型也在发生变化,团队需要了解如何将他们的 API 指南和设计实践扩展到 REST 之外。在未来三年内,API 开发将在安全、工具、测试、设计和可观察性等所有维度上成熟。我很高兴成为这个社区的一部分,共同努力创建这些新的功能。
API 技能对于被录用加入您在微软的 Dev Tools 团队有多重要? 我们的团队在微软的开发人员部门致力于广泛的开发人员体验主题。我们构建 VS Code 和 Visual Studio 扩展以及 Azure SDK。我们还领导我们的 Azure API 指南和架构评审。我们与团队合作进行 REST API 设计,以及为 Python、JavaScript、Java、Go 和 .NET 等语言设计特定语言的 API。API 技能对我们的产品管理和工程团队成员都很重要,因为每个团队成员都需要能够思考 API 或 SDK 的细节将如何影响开发人员体验。我们在招聘高级职位时会寻找 API 技能,并指导团队成员帮助他们提升 API 技能。
您个人希望从 ASC 2021 的演讲中获得什么?
以实践者为主导的会议是我最喜欢的活动类型。我期待着与其他对 API 深思熟虑并致力于设计、构建和维护 API 所涉及的所有可能性和挑战的人建立联系。我从 API 社区学到了很多东西,我很高兴能够回馈,通过帮助构建一个社区,我们都可以相互学习。
凯特·奥尼尔 (@kateo) 凯特·奥尼尔,“技术人文学者”,是 KO Insights 的创始人兼首席执行官,该公司是一家屡获殊荣的思想领导力咨询公司,帮助企业、组织和城市根据人类行为和数据做出面向未来的有意义的决策。凯特是包括《像素与场所:跨物理和数字空间连接人类体验》在内的 3 本书的作者,她在行业会议和私人活动中定期发言,提供主题演讲,参加小组讨论,并为各种规模的团队领导创意头脑风暴研讨会。
珍妮·希弗 (@jennschiffer) 珍妮·希弗是一位工程师、艺术家和科技幽默家。大多数人认识她是因为她惊人的力量,还有她作为 Fog Creek http://Glitch.com 的社区工程师的身份。她组织了 JerseyScript,这是一个每月在她在美国新泽西州泽西城举办的网络开发人员社交活动,并且建立了每个人都喜欢的免费在线像素艺术编辑器 http://Make8BitArt.com 。
我们期待今年秋天在田纳西州纳什维尔与大家见面。我们知道您拥有应该与社区分享的精彩故事,并期待您在 APIStrat 的舞台上发言。这场 API 社区会议的第 9 届活动将是有史以来最棒的一次,与往常一样,我们正在寻找尽可能多的多样化的 API 故事,并有一系列与往年相媲美的演讲嘉宾。不要错过这个机会,帮助塑造行业内正在展开的 API 故事,APIStrat 和 OAI 基金会正在塑造这个故事。