2016-06-01 10 views
0

私はNode.js/expressjsで開発したアプリケーションを持っています。それは正常に動作しています。今私はSwaggerを使用してAPIドキュメントを生成する必要があります。モジュールswagger-nodeがあります。このモジュールを使用してアプリケーション全体を書き直す必要がありますか、またはこのモジュールを使用するための他のソリューションがありますか、スガッガーノードを使用している場合はswagger-uiの使用は何ですか?swaggerを使ってnode.js APIドキュメントを生成するには

答えて

0

私には分かりません。記述されているようにあなたのswaggerプロジェクトを生成し、yamlファイルの情報があなたのコードが使用する実際のコントローラとメソッドを指していることを確認してください。

0

Swagger/OpenAPIに準拠したスタンドアロンのyamlファイルを作成できます。これは、Swaggerドキュメントにレンダリングすることができます。 Swagger-UIは、このyamlファイルを作成するのに便利です。 Swaggerには、APIのテストとコード生成のためのさまざまなツールも用意されています。これらを効果的に使用するには、yamlファイルのコントローラ/モデル定義を既存のコードベースに統合する方法が必要です。

この統合を実現するために、私は通常、自分の既存のコードベースをコントローラー関数のAPIとして公開し、文書化されたAPIによって生成されたコードにモジュールとしてインポートします。これにより、コードベース全体をSwaggerの必要なディレクトリ構造に移植する負担をかけずにAPIドキュメントを信頼することができます。私はこれが現在利用可能な最良のアプローチだと信じていますが、必ずしも価値があるとは限りません。

関連する問題