問題タブ [springfox]

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 投票する
1 に答える
1168 参照

java - ObjectNode を返すための Springfox/Swagger のカスタム ResponseModel

Swagger を使用して、Spring Boot API の API ドキュメントを提供したいと考えています。Springfox 2.3.0 を動作させることができ、ObjectNode を返すコントローラーを除いて、すべてが期待どおりに動作します。Swagger は、返されたクラス (ObjectNode) を JSON 表現に変換しようとします。結果は次のようになります。

これで、作成した JSON に含まれる値を Swagger が推測できないことがわかりましたが、正しい ResponseModel を任意の形式で手動で追加したいと考えています。

コントローラーは次のようになります。

モデル スキーマとしてドキュメントに示されているカスタム ResponseJSON を Swagger に提供する方法はありますか?

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

properties - SpringFox Swagger make XSD モデルで必要な Definition プロパティ

ドキュメントに Swagger を使用する REST webapp があり、 body パラメーターを除いてうまく機能しています。本体のすべてのプロパティはオプションです

Swagger-ui

私の Project オブジェクトは XSD ファイルで生成され、minOccurs=1 maxOccurs=1 または unboundedのすべての要素と、すべての属性がuse=requiredに設定されていることを確認しました。これには何の影響もないようです。次に試したのは、追加することでした

@ApiParam(value = "プロジェクト本体", required = true) @RequestBody ProjectInfo プロジェクト

しかし、Project オブジェクト自体が既に必要であるため、これは効果がありませんでした。Project のプロパティも必要であることを Swagger に伝える方法はありますか? Swagger に SpringFox 依存関係を使用しています。

アップデート

生成されたモデルに@ApiModel@ApiModelProperty(value = "プロジェクトの一意の名前", required = true)を追加することで、それを必要とすることができました。

しかし、私の質問は、XSD ファイルに Swagger 注釈を追加して、それ自体が生成されるようにすることはできますか? に変更されました。

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

java - Springfox Swagger2 - @ApiOperation が機能しない

Spring MVC REST API に springfox-swagger2 を使用しています。すべてがswaggerでうまく機能しますが、私の問題は、swaggerのドキュメントに追加情報を追加できないことです.

Maven の依存関係:

私のSwagger構成クラス:

私のコントローラークラス:

したがって、swagger-ui を呼び出すと、コントローラー、メソッド、および で定義された追加情報を除くすべてが表示され@ApiOperationます@ApiImplicitParams。問題がどこから来るのか、誰にも考えがありますか? パラメータは、swagger から作成された JSON ファイルにもありません。

0 投票する
0 に答える
1013 参照

java - asciidcltor-maven-plugin を使用して、springfox-staticdocs によって ascii 形式で生成された ascii ドキュメントから HTML ドキュメントを生成する方法

私はswagger2を使用してAPIドキュメントを生成しています.swaggwerからの同じjson出力がspringfox-staticdocsを介して使用され、ascii静的ドキュメントが生成されます. ascii 形式の静的ドキュメントは、junit テスト クラスで生成されます。今、テスト段階で生成された ascii ドキュメントから asciidoctor-maven-plugin を介して html ドキュメントを生成したいのですが、どういうわけか html ドキュメントが生成されず、process-asciidoc ゴールが実行されていません。ascii ドキュメントはテスト フェーズで生成されるため、'process-asciidoc' ゴールを prepare-package フェーズにバインドしています。私はここで何か間違ったことをしていますか?

mvn パッケージ

pom.xml スニペット:

springfox-staticdocs lib を使用して ascii ドキュメントを生成するテスト メソッド スニペットを次に示します。

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

spring - pom 依存関係の springfox とは何ですか?

スプリングフォックスとは。pom.xml プロパティで見ました。しかし、私はスプリングフォックスを理解できません。

上記のように、それが何を意味し、どのように機能するのか正確にはわかりません。私はそれについて検索しましたが、springfox が何であるかについての情報はありません。