javascript - 你能记录其他人使用 swagger 开发的 API 吗？

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 5 年前。

Improve this question

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

但问题是，是否可以使用 swagger 来记录这些 API？

如果是，如何？如果没有，还有其他工具/框架可以帮助我做到这一点吗？

Answer 1

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