REST APIコールのXML構造をどのように文書化しますか？

Question

SOAPと同様に、WSDLとして要求の作成に役立つコードを生成できますが、RESTにはREST API呼び出しのペイロードまたは応答を文書化するためのメカニズムがありますか？

REST APIを提供するほとんどのサービスは、構造を説明するサンプルを提供しているようです。 REST APIのベストプラクティスは何ですか？

Answer 1

xmlを返す場合は、単にxsdを入力します。いくつかのフレームワークが自動的に生成するwadlもあります。

Answer 2

構造を説明するためのサンプル（またはサンプルへのリンク）を提供することがベストプラクティスであることがわかります。あなたのAPIに取り組んでいる開発者は、サービスの各部分とやりとりする方法を知るために、特別なツールやワークフローを必要としません。