問題タブ [swagger-maven-plugin]

私は独自の RequestMappingHandlerMapping を持っており、springfox-swagger-ui を使用しています。カスタム マッピングを追加した後、http://localhost:8080/swagger-ui.html で swagger ui を実現できません。何か案は？

これが私の構成です。

ここに私のpom.xmlがあります：

私は、jaxrs を使用して開発された大規模な API をサードパーティ向けに文書化するための最良の方法を見つけるというタスクを与えられました。コードは現在、javadoc で十分に文書化されています。私の質問は、これまでの調査に基づいて最善のアプローチを特定し、正しい道を進んでいることを確認することです。そのため、入力、コメント、または追加のフレームワークを探しています。これは一般的なユースケースであり、他の人も同様の問題を抱えていると確信しています。

次の要件があります。

• コードを乱雑にする膨大な数の注釈はありません。
• ネストされたオブジェクトや適切な JSON 構造などの戻り値の型を文書化できます。
• ヘッダー、リンク、メタ情報を指定できます (つまり、swagger 1.2 ではなく 2.0 が必要です)
• 可能な限り時間とコストを最小限に抑えながら、高品質のドキュメントを維持したいと考えています。
• JDK 8 で動作します。

私は次のフレームワークを検討しましたが、それぞれにいくつかの大きな欠点があり、(このプロジェクトで) 作業が困難になったり、誤解している可能性があります。

Swagger JAXRS ドックレット:リンク

この Maven プラグインはビルド時に機能し、既存の javadoc コメントに基づいて適切なドキュメントを提供できます。ただし、Swagger 2.0 はサポートされていないため、ユースケースに不可欠な応答のヘッダーの記述に制限がかかる可能性があります。swagger maven プラグインが必要とする @Api または @ApiOperation アノテーションを必要とせずに、残りのサービスを取得できます。これをアップグレードして swagger 2.0 で動作するようにするのは、かなりの作業になる可能性があります。

Swagger Maven プラグイン:リンク

プラグインは、コメントではなく注釈に基づいて、ビルド時に Swagger ドキュメントを作成します。これには、プロジェクト全体を調べて、@Api と @ApiOperation で注釈を付ける必要があります。一部の注釈が基本クラスのみにあることで問題が解決する場合もありますが、エンドポイントの説明またはタイトルについては、注釈自体に詳細を追加する必要があります。これらの注釈の多くは重複しているように見えます。たとえば、@Get または @Post は既にありますが、@ApiOperation を追加し、javadoc で既に説明されているパラメーターを記述する必要があります。欠点は、これには時間がかかり、見た目が非常に雑然としたコードになることです。

Swagger コア:リンク

Swagger コアは実行時に機能します。つまり、既存の javadoc からコメントを削除することはできません。Swagger Maven プラグインと同様に簡単に拡張でき、独自のリーダーやルールを追加して、リンクやメタ情報を追加できます (または独自の既存の注釈を使用できます)。欠点は、各メソッドの説明をどこかから取得する必要があるため、新しいコードを追加するときに忘れられる可能性が高い (さらに多くの) 注釈に追加する必要があることです。

発音:リンク

.NET で同様のフレームワークを使用できるようにする必要があるため、Enunciate は機能しません。また、JDK 8 も (まだ) サポートしていません。

これまでの私の結論

swagger jaxrs ドックレットは、これまでのところ、私たちが望むすべてのことを行うのに最も近いものでした。主な問題は、swagger 2.0 がないことです。一緒に文書化される他のプロジェクト (異なる言語) がそうであるように、それに応じて swagger バージョンを更新できる必要があります。2 番目に良いのは Swagger Maven プラグインです。これはカスタム ランナーの場合と同様です。これはビルド時であるため、何らかの方法で既存の javadoc コメントにアクセスし、これらを生成された swagger に追加することができるはずです。一部の注釈は基本クラスにあり、カスタム リーダーを使用してコメントから残り (説明など) を取得します。最後に、swagger コアは、既存の javadoc を複製するアノテーションがさらに必要になるため、実際にはニーズに応えません。

swagger doclet を更新して swagger 2.0 をサポートするのに必要な時間が不明なため、カスタム リーダーを備えた swagger maven プラグインに傾倒しています (そこから javadoc コメントを読み取る方法に関するヒントがあれば便利です!)。私の結論を不正確にする、見逃したフレームワークや詳細はありますか?

swagger API を spring mvc REST と統合しています。Swagger UI で json データをロードしようとすると、メソッドが表示されると常にエラー コードが表示されます。変更するタイプを含む有効な出力を返す必要があります。

ここで何が起こっているのかわかりません。設定に何かミスがありましたか? 私はmangofactoryを使用しています

Swagger を使用して Spring Web MVC を実装しようとしていますが、問題はモデル スキーマを取得できなかったことです。打撃を与えられた質問でコードを添付しています。私は以下のリンクをたどっています：

http://raibledesigns.com/rd/entry/documenting_your_spring_api_with

問題は、Swagger UI が表示されていたが、ポスト リクエストではモデル スキーマが表示されていなかったことです。

POM.XML:

Spring.xml:

顧客 Controller.java:

アプリケーションのプロパティ:

cxf と camel で swagger を使用して REST ドキュメントを生成しようとしています。Swagger のドキュメントを取得することに成功しました。そして、私はswagger-uiが正しく機能しています!

だから今、私はすべてをエクスポートしてオフライン ドキュメントを作成しようとしています。それを行うために、私は次を使用します: 1) swagger-maven-plugin : REST -> json 2) swagger2markup-maven-plugin : json -> asciidoc

jsonファイルを取得できましたが、APIドキュメントが含まれていません..

pom.xml

Web.xml

アプリケーション.コンテキスト

http://localhost:8080/?url=http://localhost:8080/ws/jaxrs/swagger.jsonこの ドキュメントにはすべてが含まれています!!