如果內容類型不同，請顯示REST文檔application/json

如果客戶端Content-Type不是application/json，那麼顯示特定REST資源的文檔是一個好主意嗎？我的意思是，如果開發人員嘗試在瀏覽器中獲取REST資源URL，他會得到類似於this的內容。如果內容類型不同，請顯示REST文檔application/json

來源

2012-12-25 speechkey

雖然這是開放的討論，但在我看來這將是一個壞主意。 RESTful API的全部用途是公開您的應用程序接口供其他開發人員使用。有些開發人員會查看http標題，以確定您的REST API的某個路由是否存在，而與內容類型無關。如果我要求提供文本/純文本，我希望如果您沒有它，並且不是200/OK文檔，我會收到404/NotFound。儘管如此，我認爲它可能對瀏覽器的手動API測試有用。

來源

2012-12-25 16:36:04 Infinity

是的，你的觀點已經發生在我身上。對於使用瀏覽器測試API，您可以簡單地在瀏覽器中更改Content-Type並對其進行測試，並且通常甚至不會嘗試將API與除application/json以外的Content-Type一起使用。但是，如果你嘗試它，沒問題，你會得到文檔，看看你爲什麼錯了。 – speechkey

讓我說我寫了一個程序來請求您的api上的文本/純文本內容類型，並在成功（200 /好）我想要它存入$ 100到用戶帳戶，否則不要。在你的情況下，即使該路線不存在，它也會返回（200/ok）。在大規模應用程序中，開發人員必須處理大量不同的RESTful API，您不能指望他們爲您的代碼量身定製代碼。請注意，它是與您的API交互的程序;所以，它不能說「哦，那個頁面上有一個文檔」。 – Infinity

好吧，你是對的。如果得到一個Ok，但這個動作的結果與HTTP狀態代碼相反，這是不好的。它肯定以媒體類型錯誤結束（415）。 – speechkey

如果內容類型不同，請顯示REST文檔application/json

回答

相關問題