api的更好的url : /api或api

Question

当您制作API时，什么是更好的实践？

http://webapp/api

或

http://api.webapp/  

为什么？

我从http://webapp/api中的API和http://webapp中的服务描述开始。但是现在，我想将不同存储库中的API描述分开，为此，我正在考虑将url改为http://api.webapp/。

是个好主意/练习吗？

Answer 1

http://webapp/api的一个好处是，如果您将网站和api开发为同一代码库的一部分，那么您实际上不需要做任何特殊处理来部署api --这只是您必须部署的一个web应用程序。

如果您确实在本例中使用了api.webapp，那么您可能需要在应用程序的初始安装过程中进行一些特殊处理。

另一方面，对于http://api.webapp/，您在url中使用不同的主机名(假设您的web应用程序在http://webapp/上运行)。

这意味着它可以指向不同的IP地址-或者它可以指向同一个IP -取决于DNS配置。因此，通过使用它，您可以让api和web应用程序首先由同一个物理服务器提供服务，然后可以选择将两者分开，而不破坏您的公共接口！

因此，第一种设置可能更容易，后者给您提供更多的选项。