如何使用swagger生成Node.js API文檔

Question

我有一個使用Node.js / expressjs開發的應用程序。 一切正常。 現在，我需要使用Swagger生成API文檔。 有一個模塊swagger-node 。 我是否需要使用此模塊重新編寫整個應用程序，還是有其他解決方案來使用此模塊？如果使用swagger-node，則swagger-ui的用途是什么？

Answer 1

從我所不能說的。 您應該能夠按照描述的那樣生成您的swagger項目，然后只需確保yaml文件中的信息指向您的代碼使用的實際控制器和方法。

Answer 2

您可以創建一個與Swagger / OpenAPI兼容的獨立yaml文件，因此可以將其呈現到Swagger文檔中。 Swagger-UI對於創建此Yaml文件很有用。 Swagger還提供了各種工具來測試API和生成代碼-要有效地使用它們，您將需要一種將yaml文件中的控制器/模型定義集成到現有代碼庫中的方法。

為了實現這種集成，我通常將現有的代碼庫公開為控制器功能的api，然后將其作為模塊導入到由我記錄的API生成的代碼中。 這使我可以信任我的API文檔，而不必承擔將整個代碼庫移植到Swagger所需的目錄結構中的負擔。 我認為這是目前可用的最佳方法，但並不總是值得的。