Swaggerと比較してSpring REST Docsを使用する利点は何ですか?質問する

Swaggerと比較してSpring REST Docsを使用する利点は何ですか?質問する

Spring REST Docs が最近リリースされ、ドキュメントには次のように書かれています:

このアプローチにより、Swaggerなどのツールによって課せられる制限から解放されます。

そこで、Swagger と比較して Spring REST Docs を使用する方がよい場合と、Swagger によってどのような制限が解消されるのかを質問したいと思いました。

ベストアンサー1

ここで、あなたの質問やその他のトピックに触れたプレゼンテーションを見ました:

https://www.youtube.com/watch?v=k5ncCJBarRI&t=26m58s

  • Swaggerはハイパーメディアをまったくサポートしていません/URI中心です

  • Swagger のコード検査方法は、実際のコードより遅れる場合があります。Swagger が理解できないコードの変更が起こり、Swagger が更新されるまで適切に処理されない可能性があります。

  • Swagger には多くの注釈が必要であり、注釈内の API ドキュメントに必要な説明テキストを含めるのは面倒です。

  • Swagger がコードを検査してもわからないことがいくつかあります。

いずれにせよ、これらはほんの数点にすぎません。プレゼンターの方が私よりもずっとうまく説明してくれています。

おすすめ記事