問題タブ [spring-restdocs]

次の形式で呼び出しに対する応答を配信する必要があります。

どのように文書化すればよいですか？問題は、オブジェクトがキーとして EntryId を持つ構造であり、ドキュメントの場合に ID が含まれていないことです。変数を使用してキーを定義できるオプションはありますか? または、 responseFields で使用することをお勧めしますか?

私は素晴らしいswagger2markupプラグインを使用して、Swagger が提供する REST API の Asciidoc ドキュメントを生成しています。私はswagger2markupのドキュメントに従っており、Spring MVC統合テストを使用して、Springfox Swaggerエンドポイントからマークアップを次のように生成しています(Mavenを使用しています):

すべてがうまく機能しており、すべてのパスは最終的なドキュメントに記載されていますが、パスはすべてルートに直接表示され、リソース(コントローラーなど) によってグループ化されていないためMethod 1、 fromはfromController 1と同じレベルに表示されます。Method 2Controller 2

私の出力：

私が欲しいもの：

私が見ることができることから、このswagger2-markup Mavenプロジェクトテンプレートのようなローカルファイルからの生成を使用する場合、configプロパティを使用してタグでパスをグループ化するようswagger2markupに指示するプロパティを指定できますが、<swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>そのような構成はないようですSwagger2MarkupResultHandlerテストから使用する場合。唯一のオプションですwithMarkupLanguage()が、方法はありませんwithPathsGroupedBy()...

ここで何か不足していますか？

Web API を文書化しています。curl と httpie の例をエンドポイントへの有効な呼び出しにする必要があります。問題は、curl スニペットの例にポート番号が含まれており、それを取り除く方法が見当たらないことです。ポート番号を設定する方法はわかりましたが、完全に取り除く方法はわかりません。

何か不足していますか？これは一般的な使用例のようです。

助けてくれてありがとう！

spring mvc test に沿って Spring rest doc を使用して、安らかなドキュメントを生成しています。現在、リソースで発生する可能性のあるエラー メッセージについて説明しようとしていますが、春のドキュメントで役立つ情報が見つかりません。

私が達成しようとしているのは、http://apidocjs.com/example/ の Error 4xx セクションに似ています

何かご意見は ？

Spring Boot (v1.4.1) アプリケーションで Spring Restdocs (v1.1.2) を使用しています。

Gradle ビルド ファイルの jar タスクで、生成された出力を public/docs にコピーしています。

生成されたJARにドキュメントが表示されます

しかし、JAR を実行すると、/docs、/public/docs などの api-guide.html に対処できないようです。

誰かが私が間違っていることを説明してもらえますか?

ありがとう！

--ジョン

================================================== ===========

アプリケーション構成は次のとおりです。

およびテスト構成:

Spring REST Docs ライブラリを使用して、残りのサービスのドキュメントを作成しています。

私が抱えている問題は、名前のない入力として JSON 構造を持つ POST 要求を受け入れることです。

リクエストは次のようになります。

入力構造を文書化したいのですが、今のところそれを行う方法が見つかりません。

ドキュメントには、次のような説明があります。

しかし、私のパラメータには名前がありません。

私がこれまでに試したこと：

空の名前("")と配列表記("[]")も試しました。これまでのところ運がありません。

名前のないパラメーターを文書化することは可能ですか、それとも別の構造でラップする必要がありますか?

ありがとう、

Spring Rest Docs を使用して、REST サービスのドキュメントを生成しています。これには、テストによって開始されるライブ Spring Boot コンテナーに対して実行されるユニット (厳密には統合) テストの実行が含まれます。テストクラスは次のようになります。

アプリケーションは、EntityManager の実装に EclipseLink で JPA を使用します。

テストを IDE でスタンドアロンで実行するか、maven-surefire-plugin を使用して Maven ビルドを実行するときに存在する唯一のテストとして実行すると、すべて正常に動作します。

ただし、スイートで実行したいテストはこれだけではありません。スイートで他のテストを実行するとすぐに、ここで言及されている問題に遭遇します。

「Spring のエージェントは、アプリケーションが Spring コンテキストにアクセスするまで永続化コンテキストを初期化しません。アプリケーションが Spring コンテキストにアクセスする前に永続化クラスのロードをすでにトリガーしている場合、ウィービングは発生しません。」

次のようなエラーが発生します。

例外の説明: メソッド [_persistence_set_someField_vh] または [_persistence_get_someField_vh] がオブジェクト [mypackage.MyEntity] で定義されていません。

では、人々は通常、これを回避するために何をしているのでしょうか? 別のモジュールで SpringBootTest クラスを実行して、エンティティにアクセスする単体テストを行いますか?

Java アプリケーションで spock と groovy を使用してビルドされたテスト ケースがあります。モック mvc または安心を使用せずに、このプロジェクトにスプリング レスト ドキュメントを追加することは可能ですか?

ここに私のプロジェクトの抜粋があります