私はNode.js/expressjsで開発したアプリケーションを持っています。それは正常に動作しています。今私はSwaggerを使用してAPIドキュメントを生成する必要があります。モジュールswagger-nodeがあります。このモジュールを使用してアプリケーション全体を書き直す必要がありますか、またはこのモジュールを使用するための他のソリューションがありますか、スガッガーノードを使用している場合はswagger-uiの使用は何ですか?swaggerを使ってnode.js APIドキュメントを生成するには
0
A
答えて
0
私には分かりません。記述されているようにあなたのswaggerプロジェクトを生成し、yamlファイルの情報があなたのコードが使用する実際のコントローラとメソッドを指していることを確認してください。
0
Swagger/OpenAPIに準拠したスタンドアロンのyamlファイルを作成できます。これは、Swaggerドキュメントにレンダリングすることができます。 Swagger-UIは、このyamlファイルを作成するのに便利です。 Swaggerには、APIのテストとコード生成のためのさまざまなツールも用意されています。これらを効果的に使用するには、yamlファイルのコントローラ/モデル定義を既存のコードベースに統合する方法が必要です。
この統合を実現するために、私は通常、自分の既存のコードベースをコントローラー関数のAPIとして公開し、文書化されたAPIによって生成されたコードにモジュールとしてインポートします。これにより、コードベース全体をSwaggerの必要なディレクトリ構造に移植する負担をかけずにAPIドキュメントを信頼することができます。私はこれが現在利用可能な最良のアプローチだと信じていますが、必ずしも価値があるとは限りません。
関連する問題
- 1. オフラインSwagger APIドキュメントを生成するには?
- 2. swaggerまたは他のツールを使用してRest APIドキュメントを生成する
- 3. Javax上でSwaggerを使用してAPIドキュメントを生成します(JEEの下)?
- 4. Swaggerを使用したSpring REST APIドキュメント
- 5. Swaggerを使用したJersey Rest APIドキュメント
- 6. swagger swashbuckleを使用して生成されたAPIドキュメントを安全にする方法
- 7. Swashbuckleを使ってyaml swaggerを生成する
- 8. Sphinxを使ってPythonドキュメントを生成するにはglob:
- 9. Swagger 2.0を使用してREST APIドキュメントを作成中このエラーが発生する
- 10. SwaggerはNode.JS Expressサーバーコードを生成します
- 11. Django rest framework ApiドキュメントSwagger 2.0
- 12. swagger APIからjava googleエンドポイントサーバースタブを生成
- 13. APIドキュメント生成ツール
- 14. swagger-uiで生成されたドキュメントの@PostMappingパラメータを表示するには?
- 15. REST APIドキュメントの生成
- 16. Microsoft Cognitive Services RecommendationsのSwagger生成API
- 17. RubyベースのREST APIドキュメントを生成し公開する
- 18. 別のテンプレートを使ってRubyのドキュメントを生成するには?
- 19. Swagger2を使用してSpringブートREST APIドキュメントを生成する方法は?
- 20. Spring Securityを有効にするとSwaggerでドキュメントが生成されない
- 21. カスタムレストゥルーAPI(C#.NET)の定義を生成するためのSwagger
- 22. Web API Asp.net MVCのドキュメントを自動的に生成する方法は?
- 23. コマンドラインツールを使用してSwagger APIをAWS APIゲートウェイにインポートする
- 24. Springブートを使用したSwagger REST APIドキュメント
- 25. Swaggerドキュメンテーションを使ってMocking Rest Apiを試す
- 26. Swagger APIドキュメントにSwashbuckleを使用してサブクラスを含めるにはどうすればよいですか?
- 27. golangはgorilla/muxを使用して残りのAPIドキュメントを生成します
- 28. saber apiはlaravelを使ってトークンを生成します
- 29. Swagger APIがドキュメントを更新していません
- 30. APIドキュメントを提供するswagger-nodeのみ