rest - Content-Type が application/json と異なる場合に REST ドキュメントを表示する

Question

Content-Typeクライアントが 以外の場合、特定の REST リソースのドキュメントを表示するのは良い考えapplication/jsonですか? つまり、開発者がブラウザーで REST リソース URL を取得しようとすると、次のような結果が得られます。

Answer 1

これは議論の余地がありますが、私の意見ではそれは悪い考えです。RESTful API の全体的な目的は、他の開発者が使用できるようにアプリケーション インターフェイスを公開することです。一部の開発者は、http ヘッダーを見て、コンテンツ タイプに関係なく、REST API の特定のルートが存在するかどうかを判断しました。text/plain をリクエストした場合、200/OK のドキュメントではなく、それがない場合は 404/NotFound を受け取ると予想されます。ただし、ブラウザーを使用した手動の API テストには役立つと思います。