2017-04-06 16 views
3

Spring MVCプロジェクトにSwagger UIドキュメンテーションを生成する場合、基本的にEnunciateとSpringFoxの2つのオプションがあります。Spring MVCのSwagger JSONの生成:SpringfoxまたはEnunciate

私は被験者に没頭しましたが、どちらかというと良い意見がありませんでした。

私の見解では、Enunciateはあなたのプロジェクトにとって完全に外部的なので好ましいと思われます。特別なBeanをコンフィグレーションで追加する必要はありません。注釈付きの追加パッケージを参照したり、コントローラに注釈を付ける必要はありません。あなたは、カスタムタグを使ってJavaDocを簡単に使用することができます。

他の考慮事項がありますか?

ありがとうございました。

答えて

1

の両方を使用した後、私は次のキーの違いを見つける:

  • 発音するが、ビルド時に注釈を評価し、Springfoxは
  • (ランタイム対時間をビルドする)アプリケーションコンテキストからのSpring MVCの構成を読み取り発音することができますドキュメントの一部としてJavadocを使用してください(ビルドとランタイム)
  • Springfoxは、標準のMavenライフサイクルにうまく適合しない、さらなるコード生成に使用できるスガーガー設定ファイルを生成するテストが必要です。コード/ドキュメントの生成にはgenerate-sources/generate-resourcesを使用することをお勧めします。 springfoxでは、テストを実行した後に生成することに固執しています。
  • springfox-swagger-uiのSpringfoxは、あなたの既存のSpring Boot/MVCアプリケーションの上に魅力的なUIを追加する本当に簡単な方法です。 OTOHは、ReDocのようなものを使って生成されたSwagger Specとほぼ同じシンプルですが、より柔軟です。
  • Springfoxはあなたのアプリケーション内でかなりの設定を必要とするので、あなたのアプリケーションはSpringfoxにランタイム依存関係を持ちます。
関連する問題