使用实时数据库执行swagger的api文档

Question

我是api文档时代的新手。

修改这个api documentation，我就可以发布和查询数据了。我知道这是一个带有swagger的演示api文档。

但是，现实世界的API文档会发生什么呢？我是否有使用不同数据存储的demo.api.myawesome.com文档和api.myawesome. com上的实际应用编程接口？

但再次深入挖掘，我发现应用程序接口可以使用swagger libraries进行自我记录。这似乎是api和文档都在使用相同的数据存储，但事实并非如此。

这里我漏掉了什么？

Answer 1

来自Swagger网站：

Swagger是一组描述REST格式的规则(换句话说，是一种规范)。这种格式既是机器可读的，也是人类可读的。因此，它可以用于在产品经理、测试人员和开发人员之间共享文档，也可以由各种工具用于自动化与API相关的流程。

所以，是的，它使用与实际API相同的“后端”。它只是将其可视化，允许您通过Swagger UI与其交互。

Answer 2

如果您指的是Swagger UI -“试用”按钮将请求发送到由规范中的host属性指定的服务器。如果host指定您的生产服务器，请求将被发送到生产服务器；如果它指向沙箱，“试用”将使用沙箱。您可能有一个内部使用的规范版本，指向生产环境，以及一个公共版本，指向沙箱。

请注意，Swagger支持authentication，以确保只有授权用户(例如，拥有有效凭据或API密钥的实际客户)才能进行API调用。

您可以在规范中省略host以禁用“试用”功能-这样您仍然可以拥有API文档，只是没有交互部分。