api - 构建 API URL : subdomain vs. 子目录和版本控制的不同方法之间的权衡是什么？

Question

关闭。这个问题是 opinion-based .它目前不接受答案。

---

想要改进这个问题吗？ 更新问题，以便 editing this post 提供事实和引用来回答它.

关闭 9 年前。

Improve this question

我们有一个域名为 example.com 的 Web 应用程序。现在我们想将此应用程序的一部分扩展为 REST API，我们正在讨论最佳 URL 模式。

我们可以使用 URL 模式 api.example.com 或 example.com/api。如果有的话，需要考虑哪些权衡？

此外，关于 API 版本控制方法有哪些权衡？它可以通过 URL(v1.api.example.com、example.com/api/v1 或一些奇怪的组合 v1.example.com/api 或 api.example.com/v1)。或者，可以通过使用 HTTP 请求 header (或其他方式)来完成？

Answer 1

这取决于您的需求。

如果您使用 http://api.example.com它使您的 API 成为子域。基本上，如果您的 REST 服务要被多个客户端使用，则此 URL 模式很好，但如果只有一个客户端连接到您的 API，那么模式 http://example.com/api/v1很好。但是，如果您想添加更多 API 并连接更多客户端，最好使用 http://example.com/api/v1 .例如，请考虑以下内容。

http://example.com/reportapi/apioperation?parameters

http://example.com/paymentapi/apioperation?parameters

http://example.com/searchapi/apioperation?parameters

最后但并非最不重要的一点是，PayPal 使用模式 http://example.com/api/v1 .