注釈を付けずにSwaggerを使用して既存のJAX-RS実装を文書化する

コードを変更することなく、既存のJAX-RS実装のSwaggerドキュメントを生成したいと思います。クラスを飾るSwagger注釈を導入する必要はありません。ここで注釈を付けずにSwaggerを使用して既存のJAX-RS実装を文書化する

。

Swaggerを使用するようにアプリケーションを構成した後、swagger.jsonを生成できるようにコードを注釈する必要があるようです。私は正しい？アノテーションは必要ですか？そうでない場合は、その目的をよく理解していません

コードを変更せずに既存のJAX-RSアプリケーションを文書化するこの魔法はありますか？

これは解決策ですか？

2016-04-25 pvm14

JAX-RS実装にドキュメントを追加するには、スワッガーアノテーションが必要です。目的は、APIの操作とパラメータを定義することです。その意味と目的は何ですか。

共有したリンクは、何らかのハックメカニズムのようです。しかし、あなたが明示的にそれを宣言しない限り、どのコードがあなたのAPIの意図をどのように見つけることができるかわかりません。

のみクラスレベルで@Apiを使用し、メソッドレベルのアノテーションを使用しないでください：あなたが闊歩注釈の使用量を最小限に抑える必要がある場合は

は、これを行うには2つの方法があります。これにより、基本的なswagger.jsonがGET/POSTなどのAPIのリストにレンダリングされます。
ここで注釈を使用してください。 APIクラスではこのインターフェイスを拡張するだけです。これにより、既存のクラスへの影響が軽減されます。

希望します。

2016-04-25 06:43:43 Sampada

答えて