問題タブ [spring-restdocs]

Spring Boot 1.4 の導入@AutoConfigureRestDocs( http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docsを参照) ）。ドキュメントの状態：

Spring REST Docs を使用するように MockMvc を自動的に構成し、Spring REST Docs の JUnit ルールの必要性を取り除きます。

mockmvc の代わりに、Spring REST Docs の安心サポートを使用したいと考えています。でこれを行うことはできます@AutoConfigureRestDocsか?

Spring REST Docs を使用して、API のドキュメントを生成しています。ここのチュートリアルからbuild.gradleにすべてを追加しましたhttp://docs.spring.io/spring-restdocs/docs/current/reference/html5/

私がやった後gradle build、build/asciidocディレクトリファイルが生成され、build/generated-snippets.

しかし、IDEA gradle タスクから実行しbootRunて localhost:8080/docs/index.html にアクセスしようとすると、404 が見つかりません。テストのために、いくつかのindex.htmlファイルをresources/staticディレクトリの下に配置しようとしましたが、ファイルbootRunにアクセスできlocalhost:8080/index.htmlますその後。

.jar ファイルを開くと、ディレクトリの下に静的ファイルが表示さBOOT-INF/classes/static/docsれるため、jar にパックされます。

多分誰かが同じ問題を抱えていましたか？

を使用spring-boot-rest-docsして API ドキュメントを作成しています。そのドキュメントから が提供するドキュメントにリンクしてspring-boot-actuator-docs、サービスの利用可能なエンドポイント ドキュメントを完成させたいと考えています。

問題は、推奨されるランタイム依存関係を含めると、ランタイム エンドポイントがアクチュエータのドキュメントorg.springframework.boot:spring-boot-actuator-docsで上書きされることです。/docs/index.html

自分のサービスの asciidoc ドキュメントからハイパーリンクできるように、アクチュエータのドキュメントを別の URI に表示するように設定することはできますか?

フィールドの説明を提供するために (フィールドレベルで) 注釈を使用することは可能ですか?

私はdescriptionそのためにメソッドを使用できることを知っています

しかし、その説明をフィールド定義と一緒に応答オブジェクトに入れたいと思います。

制約の説明 ( http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#_using_constraint_descriptions_in_generated_snippets )を生成できたことはわかっていますが、検証注釈の説明のみが生成されました。

Swaggerのhttps://github.com/swagger-api/swagger-core/wiki/Annotations#apimodelpropertyのようなものを探しています。

私のアプリは と を使用spring-data-restしてspring-restdocsいます。私のセットアップは本当に標準的です。ドキュメントからほぼ完全にコピーされていますが、何か不足している場合に備えて、以下のサンプルを含めました. 私の mvc テストを実行すると、次のように失敗します。

これは私のテストコードです:

スタックは次のとおりです。

上手にプレイするにはどうすればいいですspring-restdocsか？spring-data-rest

私のdocumentationインスタンスは次のように定義されています。

@meistermeier が示したように (そして、リンクを無視するための restdocs ドキュメントに従って、追加できます

しかし、それでも私には次のことが残っています：

_links常に同じエンティティへの自己参照を持っているようですよね? 次のように、すべてのテストでエンティティ固有のリンクを無視せずに、これをきれいに処理するにはどうすればよいですか。

上記の行を追加しても (すべてのフィールドがすべておよびself _self curies/またはになるように)、テストの結果はこの質問の上部にある元のエラーに戻ります。itemignored()optional()

Spring RestDoc を AsciiDoc と一緒に使用して、残りの API を記述しています。RestDoc は、記述された要求パラメーター/応答フィールドなどがあるかどうかに応じて、異なるファイルを生成します。存在するファイルを条件付きで含む 1 つのテンプレートが必要です。

このようなもの：

または、少なくともファイルが見つからない場合の警告を除外します。しかし、これらを抑制する方法がわかりませんでした。