RESTful API 设计全解析:从社区标准到元数据规则
1. 社区标准化
遵循开放联盟所描述的标准和命名约定,能让我们的 API 更具可用性和互操作性。像开放旅游联盟(OTA)和开放地理空间联盟(OGC)就是这类联盟的典型代表。
社区标准化原则建议,在有行业标准信息组件可用时,API 实现应使用这些组件进行设计。例如,用于日历邀请和活动的 iCalendar、用于姓名和地址信息的 vCard,以及用于地理空间数据的 Keyhole 标记语言(KML),都是我们的 API 可以充分利用的明确标准。
2. API 游乐场
API 提供者应开发并开放一个相关的网站或开发者门户,方便开发者快速上手他们的 API。这个门户可以为新客户提供文档、论坛,以及通过安全的 API 访问密钥进行自助服务配置。
对于 APP 开发者来说,不仅要通过文档了解 API 及其功能,还要在一个可控、可监控的环境中,使用直观的工具和技术来测试和操作数据,这一点至关重要,也能极大地激发开发者学习和使用 API 的兴趣。
交互式的浏览器内 API 游乐场是潜在用户识别 API 端点并测试代码、体验 API 行为的最佳方式之一。
API 提供者可以通过沙盒、虚拟化和 API 游乐场这三种不同方式,吸引 APP 开发者来体验 API 功能:
- API 沙盒 :是一个有限区域内有特定规则的受控环境,提供简单的 API 调用。
- 虚拟化 :是真实 API 的镜像,为 APP 开发者提供类似生产环境的环境,以便进行更准确的测试。
超级会员免费看
订阅专栏 解锁全文
10万+

被折叠的 条评论
为什么被折叠?



