你能记录别人使用 swagger 开发的 API 吗？ [关闭]答案

【问题标题】：Can you document the APIs which are developed by someone else using swagger? [closed]你能记录别人使用 swagger 开发的 API 吗？ [关闭]
【发布时间】：2017-12-05 18:15:31
【问题描述】：

我是 swagger.io 的新手。我有一堆 API 是由一个不再与我合作的团队开发的。因此，他们没有正确记录这些 API。所以，我正在考虑使用 swagger 并正确记录它们。

但问题是，是否可以大摇大摆地记录这些 API？

如果是，如何？如果没有，是否有任何其他工具/框架可供我使用？

【问题讨论】：

你可以访问源代码吗？
不，我无权访问源代码。
那么你不能用 Swagger 记录 API，至少用 Java 是这样。 Swagger 通过放置您要记录的方法和字段的 Java 注释来工作。如果你没有源，你显然不能这样做。我不确定 Swagger 如何与 JS 一起工作，但我想它可能类似。
谢谢，但有没有其他工具/框架可以在不访问源代码的情况下做到这一点？

标签： javascript java api swagger swagger-ui

【解决方案1】：

是的，您可以在Swagger Editor 中手动为 API 编写 OpenAPI (fka Swagger) 定义（.yaml 或 .json），然后使用 Swagger UI 显示 API 文档。但是，在这种情况下，OpenAPI 定义与 API 实现不同步（即未链接到源代码），因此如果实现发生变化，您将需要手动更新 OpenAPI 定义。

【讨论】：

【解决方案2】：

不招摇，但WireMock会让观察和记录一个API作为一个黑盒子。

http://wiremock.org/docs/record-playback/

【讨论】：