問題タブ [swagger-maven-plugin]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
6 に答える
85566 参照

java - Swagger の列挙型

列挙型をswaggerで文書化する方法を知りたいです。

JavaDocによると

データ型。サポートされているデータ型については、ドキュメントを参照してください。データ型がカスタム オブジェクトの場合は、その名前を設定するか、何も設定しません。列挙型の場合、列挙型定数に 'string' と allowableValues を使用します。

しかし、実際にそれを使用する良い Java の例が見つかりませんでした。仕様はこちらです。

ジャワ

最初のサービス

セカンドサービス

入力

出力

pom.xml

結果はこちらでご覧いただけます

私が見た HTML 出力には多くの問題があります (出力の説明がない、URL が間違っている、説明がメモに使用されている) が、解決方法がわからないのは列挙型の使用法です。

tests-swagger\target\generated\apidocs\first.jsonある必要があります(私は思う)

しかし〜がある

これ$refは私が思う問題です...

何か案が?

0 投票する
1 に答える
7033 参照

java - swagger アノテーションがデフォルトのパスプレフィックスで api-docs を生成するのはなぜですか?

以下の Maven プラグインを使用して、swagger をアプリケーションと統合しました https://github.com/martypitt/swagger-springmvc

私は春のサーブレットxmlで以下を設定しました

私のswaggerプロパティは以下のようになりました

documentation.services.basePath= http://payrollservice.com/customservice documentation.services.version=1.0

生成される api-docs.json は以下のようになりますが、ベース パスがない理由とプレフィックス "/default" がある理由がわかりません。

0 投票する
1 に答える
885 参照

jersey-2.0 - swagger を使用してジャージーから JSON 定義を生成する

私の目標は、Jersey リソースからこのような闊歩定義を生成することです。

これを取得するには、私の pom.xml は次のようになります。

また、swagger/jersey 依存関係もありました。

json は適切に生成されていますが、1 つだけではなく、リソースごとに 1 つの json ファイルを取得しています

私が欠けているもの

0 投票する
1 に答える
2448 参照

java - Swagger includePatterns()

Swagger 構成:

レストコントローラー

参照:一部の情報はここから参照されています: http://java.dzone.com/articles/how-configure-swagger-generate

問題/質問:

メソッドでは、API としてパターンをSwaggerConfig.java指定すると、Swagger 出力ページに表示されませんが、パターンをそのまま含めると表示されます。なんで?このユースケースのとの違いは何ですか?includePatterns()/account/*/account/.*/account/*/account/.*

アップデート:

別のユースケース

パターンを として追加すると/score/*、API が Swagger に表示されます。パターンを次のように配置する必要はありません/score/.*

0 投票する
2 に答える
872 参照

java - Mavenで生成されたwebappアーティファクトをどこに置くのですか?

swagger maven プラグインを使用して swagger.json ファイルを生成しています。これを webapp (src/main/webapp) の静的リソースとして利用できるようにしたい。

github ページの例では、このように構成しています。

webapp フォルダーにないため、これがどのように役立つかわかりません。便利な場所に手動でコピーする必要があると思いますが、自動化されていない場合、mavenのポイントは何ですか。

私は自分のプロジェクトでこのように構成しました。

これにより、開発中 (Eclipse プロジェクトとして) とデプロイ時 (ビルドされた war ファイルとして) の両方でファイルにアクセスできます。

問題は、生成されたアーティファクトを通常の src/main フォルダーにポップしてもよいかどうかです。

jaxb からコードを生成しましたが、それはターゲット フォルダーの generated-sources フォルダーに入ります。これはEclipseのソースフォルダーとして追加され、mavenはこれらのクラスをビルドに追加することを認識しています。

私は基本的に、生成されたコードを src/main/webapp にダンプして、Maven の偽物をコミットしていないことを確認したいだけです。このファイルを gitignore する必要があることはわかっています。

0 投票する
1 に答える
2743 参照

java - Spring MVC を使用した Swagger 2.0.3 が HttpMediaTypeNotAcceptableException をスローする: 受け入れ可能な表現が見つかりませんでした

次の Maven 依存関係とプラグインを使用しています

以下の beans.xml では、Bean の定義は次のとおりです。

以下のブログを参考にしました

ブログに記載されている早期アクセス版はダウンロードできないので使えません。バージョンを 2.0.3-SNAPSHOT に変更したところ、HttpMediaTypeNotAcceptableException 例外が発生しました。WAR ファイルを生成することができ、ログで 、上記の例外を使用してhttp://localhost:8080/example/v2/api-docsを使用してアクセスしようとしたときに、Swagger で適切に作成されたリソース グループを確認できました。投げられました。

助けてください。