2016-10-04 11 views
0

20以上の異なるREST APIを実装し、パッケージスキャンでJersey 1.17.1を使用する既存のJavaアプリケーションにSwagger 1.5.0サポートを追加します。誰もベストプラクティスの推奨事項はありますか?たとえば:Swagger:異なるAPIの共有情報を結合する方法

  • は、各Javaクラスに追加された定義を闊歩すべきか、彼らは することができ、各クラスに触れないように独立したファイル(複数可)に追加?
  • 各APIには、@ApiImplicitParamを使用して最初のクラスについて詳細に定義したヘッダーと同じセットが必要です。 の代わりに、すべてのクラスのすべての操作のためにその情報を繰り返します。 そこにすべてのAPIに適用する方法がありますか?

答えて

0

JAX-RSアプリケーションを使用して、スガーガー1.5.xライブラリ(注:1.5.10が最新のものです)を統合するための膨大な方法があります。私はあなたがswagger-petstoreのようなスキームに従って、論理的な組織を提供すべきトップレベルパスセグメントでファイルを分割することをお勧めします。

繰り返しヘッダーの場合、各リソースクラスに注釈付きクラスレベル変数を持つ基本クラスを拡張させることができます。それはそれを拡張するクラスの各操作に適用されます。

+0

ありがとうございます。私はペットショップの例を閲覧しました。これは、始めるにあたっての魅力的なアプリケーションとして設計され実装されています。私は、アプリが何をしているのかを模倣するために、アプリに大量の変更を加えなければならないだろう。私のアプリに関連する部分の例があるなら、私はそれを指摘していただければ幸いです。 2番目のレスポンスは、すべてのAPIクラスが基本クラスを既に拡張しているので、非常にエキサイティングです。私は役に立たないでいくつかの異なるものを試してみました。それを実装する方法を詳しく説明できますか(たとえば、ベースクラス、APIクラスなどで使用するアノテーション)... – user3722575

+0

基本クラスの共通のパラメータとAPIクラスの特定のパラメータを定義することで動作させました。ありがとう。 – user3722575

関連する問題