如何直接在瀏覽器中查看和調試Django-Restful介面
編程應用、實戰教程,不容錯過
博客zmister.com備案完成,恢復訪問,同時問答系統籌備上線中,以後大家有問題可以直接在問答中進行提問:)
一、前言
我們創建好的web介面都通過Postman這個軟體調用各種HTTP請求方法來進行調試和查看,這樣返回的結果很容易被編程語言和應用程序所接收和識別,但是卻並不便於我們直觀的查看。
之前我們使用OPTION方法對介面進行請求測試的時候,會發現介面的頭描述中提示不僅會渲染json數據,還會渲染html數據:
這是django-rest-framework框架為api的請求方設定的:在默認情況下,介面返回標頭指定的格式。像我們使用Postman軟體,默認的標頭會是application/json,其就會返回json格式的數據:
如果我們使用瀏覽器對介面進行訪問,瀏覽器默認的請求標頭會是text/html,介面就會將數據以HTML的形式進行返回。下面我們來試驗一下。
二、在瀏覽器中瀏覽介面
不需要做其他額外的配置,直接在瀏覽器中打開API介面的URL地址,就可以看到以HTML文檔而不是JSON格式呈現出來的介面響應數據,如下圖所示:
可以看到,api介面的響應以比較友好和美觀的HTML顯示在瀏覽器中,django-rest-framework框架默認使用bootstrap前端框架來呈現頁面的樣式。
除了簡單了瀏覽介面之外,HTML形式的介面還提供了頁面按鈕和表單供我們直接在瀏覽器上進行簡單的介面調試,只要是介面設置所允許的HTTP請求方法,頁面上都會有相關按鈕來提供操作,如下圖的電影列表介面所示,頁面上提供了OPTION、GET和POST三個請求方法的操作:
在電影詳情介面,則提供了DELETE、OPTION、GET和PUT請求方法的操作:
通過這些頁面的操作,我們不需要再打開Postman軟體,而是直接在瀏覽器中對介面進行各種調試。
當然,如果想要在瀏覽器中查看json格式的響應,也是可以做到的。
默認情況下,介面在瀏覽器中返回HTML格式,但是我們可以使用format參數指定響應的格式,比如返回json格式數據電影列表的url為:
使用了format參數指定返回數據為json數據,那麼瀏覽器中就會直接呈現json數據,如下圖所示:
如果將format參數的值改為api,那麼其顯示方式又將是HTML。django-rest-framework框架的這個功能是不是很有用?
TAG:州的先生 |