Spring REST Docsに「試してみる」フォームを組み込む

Question

Spring REST Docsを使い始めましたが、すごく素敵な機能が欠けています...「試してみてください！ APIをテストするためのHTMLフォームを含むボタン。私はカールリンクOKを取得します。しかし、私は通常、控えめな形を使用します。 Spring REST Docsでこれを行う簡単な方法はありますか？ ありがとう

Answer 1

いいえ、それが提供できると私が信じる最も近いものはcurlです。以下のような単純なオープンポストマンコレクション、https://github.com/spring-projects/spring-restdocs/issues/47を提供するための機能強化、何もありSWAGGERのtry it out!

もややこのチケット、 https://github.com/spring-projects/spring-restdocs/issues/213から関連

、私はむしろ生成するためのサポートを追加しようとしているに引き裂かれてい

Swagger仕様。 Swaggerを「APIプレイグラウンド」として提供すると説明すると、他の多くの人が分からない非常に重要な違いがあります。私は、SwaggerのUIはAPIドキュメントの代わりではないと確信しており、そのようなものを使用することはサービスやそのユーザーにとってはあまり役に立ちません。

私の恐怖は春RESTドキュメントが 闊歩仕様を生成するためのサポートを提供している場合、人々はその後、闊歩のUIを移入 にその仕様を使用し、そのサービスを文書化することが検討するということです。 人々に正しいことをさせることを信頼することが重要です。 は、人々が足で自分自身を撃つように励ますのに対してです。

Answer 2

Spring REST DocsのcURLスニペットをPostmanコレクションに変換するツールを作成することで、私はそれを解決しました。これはnpmパッケージとして利用可能です：https://www.npmjs.com/package/restdocs-to-postmanこれはコマンドラインやライブラリとして使用できます。これはhttps://github.com/spring-projects/spring-restdocs/issues/47の1つの解決策です。私の意見では、PostmanのようなツールはAPIを試してみるのが良いです。

編集：郵便配達員と不眠症からスワッガーへのコンバーターがあります。したがって、2回のコンバージョン（郵便配偶者/不眠症と郵便配偶者/不眠症からスガッガーへのrestdocs）では、スワッガーの遊び場を手に入れることができます。これは最適ではありませんが、機能します。コンバータ用

例：SWAGGERへ

• 郵便集配人：https://apimatic.io/
• 不眠症闊歩する（トライアルと有料サービス）：https://github.com/mlabouardy/swaggymnia（MITライセンス）

編集2：私が持っていますSpring RESTからSwaggerプレイグラウンドを作成する方法に関する作成された指示REST Docs：https://github.com/fbenz/restdocs-to-swagger Spring REST Docsが悲惨であれば、いくつかのステップが必要で単純になりますSwaggerファイルを作成しますが、動作し、自動化することができます。