使用Postman管理API接口

爲了使服務端開發的API接口管理正規化流程化,因此,使用Postman這款神器來管理咱們的接口,以方便後續項目的迭代開發。php

1、什麼是Postman

Postman最基礎的功能就是發送http請求,支持GET/PUT/POST/DELETE,還有不少其餘的http方法。個人理解就是能夠經過這一款神器,達到模擬瀏覽器提交各類API請求,好比咱們最經常使用的是和APP端的協做開發,服務端開發好API接口後,APP端同事須要調用咱們的接口,每每咱們服務端管理許多接口,若是須要對某一個接口進行測試,都是在服務端對相關接口的方法進行調試,若是沒有問題,則直接給APP端,這樣雖然操做起來比較簡單,可是不太效,有時咱們也用curl模擬進行請求,看接口是否正常,可是這樣也比較慢,不直觀,若是牽扯到權限驗證access_token,則又會比較麻煩,因此,這裏強烈推薦使用Postman這款比較強大的模擬請求工具來進行接口管理。laravel

2、使用

咱們使用laravel-china.org提供的PHPHub開源項目的API來對Postman進行練手,因此,在這裏要感謝他們的開源共享精神!git

1.具體步驟

1.下載 Postman

2.導入 接口信息文件

clipboard.png

3.導入 環境設置文件

點擊設置標識,而後進入管理環境
clipboard.pnggithub

將該連接的json文件下載到本地,而後導入:
clipboard.pngjson

咱們能夠看一下咱們導入的環境:segmentfault

clipboard.png

導入的這些參數,在待會請求時會是環境中全局的參數,這樣就能夠避免每次請求時須要給接口添加特定參數的麻煩了,如url爲接口域名,在使用時咱們只須要這樣封裝https://{{url}}/users/me便可,還有若是請求用戶的時候,須要用戶權限的驗證,如咱們在拿到受權後,能夠將該Token添加到環境變量中,這時若是後邊須要,便可經過變量拿到,因此很是方便。api

2. 示例

讓咱們切換到PHPHub API Staging環境下,而後經過POST 提交{{url}}/oauth/access_token獲取客戶端的access_token瀏覽器

clipboard.png

咱們須要從上面的請求結果中獲取到用戶Token,並將這個值保存到環境變量中,以供後續使用。將下面這段代碼添加到測試編輯器中:cookie

var data = JSON.parse(responseBody);

if (data.access_token) {
  tests["Body has access_token"] = true;
  postman.setEnvironmentVariable("access_token", data.access_token);
}
else {
  tests["Body has access_token"] = false;
}

clipboard.png

最後獲取登錄的Token,即爲password_token也加入到環境變量中session

clipboard.png

該phpHub開放的API接口參數說明:

clipboard.png

若是爲通常APP端請求,則須要傳遞client_token,才能獲取通常的信息,如文章信息,回覆信息等,若是須要發表文章,則須要用戶登錄受權,既拿到password_token才能夠進行須要權限的操做,由於APP端沒有session,cookie,因此,只能經過各類Token來從服務端獲取受權進行相關的操做。
參考博文:

PHPHub Staging API 已開放
基於Postman的API自動化測試

相關文章
相關標籤/搜索