BR 技术头条

技术头条

技术链接、资讯与社区分享流

bl blog.alswl.com / 2023-04-07 00:37 / by @技术头条

实用 Web API 规范

当开始创建一个新系统,或参与一个新团队或项目时,都会面临一个简单却深刻的问题:这个系统(Web Server)的 API 是否有设计规范?

这个问题困扰了我很长时间,始于我求学时期,每一次都需要与团队成员进行交流和讨论。从最初的自由风格到后来的 REST,我经常向项目组引用 Github v3 和Foursqure API(已经无法访问,暴露年龄) 文档。然而,在实践过程中,仍然会有一些与实际工作或公司通用规范不匹配的情况,这时候我需要做一些补充工作。最终,我会撰写一个简要的 DEVELOPMENT.md 文档,以描述设计方案。

但我对该文档一直有更多的想法,它还不够完善。因此,我想整理出一份简单(Simple)而实用(Pragmatic)的 Web API 最佳实践,也就是本文。

发表评论