REST APIのルートページのベストプラクティスは何ですか？

StackOverflow https://stackoverflow.com/questions/2894723

  •  04-10-2019
  •  | 
  •  

質問

REST Webサービスのルートエンドポイントについていくつかのベストプラクティスがあるかどうかを知りたいですか？つまり、API自体の使用に関する短いドキュメントである必要がありますか？利用可能なすべての方法を説明するXMLドキュメントである必要がありますか？ 「不明な方法」のみを返す必要がありますか？

役に立ちましたか？

解決

尋ねられたこの質問は不明です。すべてのAPIメソッドが下にあるディレクトリのようなものを意味すると思います。たとえば、Flickr APIのルートディレクトリは http://api.flickr.com/services/rest/.

Flickr APIにアクセスするプロジェクトの例については、 Python-flickrapi

他のヒント

質問は私にとって完全に明確です。

404で応答するはずだと思います。ルートパスに関連するリソースがない場合、戻るものは何もありません。

404が役に立たないと感じた場合は、ドキュメントのURLを返しても問題ありません。

1. NerddinnerはWCFデータサービスを使用しています。これは、Restfulサービスを正しく実装する素晴らしい方法です。私がそれを指摘している理由は、WCFデータサービスではなく、それがパブリックウェブサイトであり、使用できるためです。 2. MediawikiはURIで行動を渡しているため、素晴らしい例ではありませんが、技術的には安らかなサービスであり、多くの興味深いアイデアです。

REST APIのルートエンドポイントは、ディスパッチャーセルヴレット後のURLの最初のスラッシュ、つまり "/"で定義されたAPIです。リソースのリストのすべての取得（主にすべてのデータベーステーブルのGET）が含まれています。このリストにはすべてのアイテムが含まれており、単一のアイテムには削除、Put/Patch、およびSelf Get URLがあります。したがって、hateosの実装を行います。

私の意見では、休息は自己記述であるはずです。 APIの残りの部分をナビゲートできる情報を含むルートが好きです。したがって、たとえば、ルートには、APIユーザーがカテゴリを選択できる製品カテゴリのリストへのリンクが含まれている場合があります。次に、製品のリストなどを使用できます。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top