Graph Explore的使用介紹

老王717發表於2021-01-22

我在Graph API開發中用的最多的測試工具就是Graph Explore,這個是微軟開發的網頁版的Graph API的測試工具,能滿足我大部分需求。

訪問網址是:Graph Explorer - Microsoft Graph

基本介面如下:

 

 基本上分成4個區域

1.使用者登入

2.Graph API查詢的樣例和查詢歷史

3.使用者查詢

4.返回結果

 下面來一個個說明一下具體的作用。

1.使用者登入

你可以用自己申請到的office 365開發者賬號登入。登入後,點選登入名右邊的齒輪圖示,可以進行下面的一些設定。第一項會引導你去Office 365的網站匯入一些測試用的使用者、文件等,如果你的Office 365網站沒有任何資料,使用沙箱是非常好的一個辦法。第三項是設定許可權,你可以在這裡提前授權你需要的許可權,如果沒做也沒關係,後面在每一條請求的時候,也可以做類似的操作。

 

 2.查詢樣例和歷史

這裡提供了很多Graph API的查詢樣例,雙擊後就可以直接顯示到右邊的查詢視窗,非常方便。但是這裡提供的大多是最基本的一些查詢,更多的還是需要自己在查詢視窗自行建立。

 

 歷史tab下面可以儲存你過去30天所有的查詢記錄,包括成功的和失敗的。你也可以匯出和刪除所有記錄。

 

下面來說一說最重要的兩個部分。

3. 使用者查詢。

首先是選擇HTTP請求的方法,一共有5個方法可選。

 

 

然後選擇Graph API的版本,大部分情況下使用1.0就可以了。有的查詢命令只在beta裡面有,但是微軟官方說在beta中的查詢命令,可能隨著新版本的釋出會進入到1.0中,然後從beta裡面刪除,所以開發中還是儘量使用1.0版本,以免程式後續查詢失敗。

 

 查詢命令輸入,這裡測試一條查詢,得到我的Office 365測試環境中所有的使用者數。返回結果一會兒再看。

 

 Request Body裡面是使用Post,Put,Patch,Delete方法時,輸入一些查詢條件。比如下面示例,是在Office 365中新增一個使用者。Request body裡面就是這個使用者的一些詳細資訊,通常是JSON格式的。

 

 Request Header裡面是填寫HTTP request headers。

 

 當你的查詢請求返回401未授權結果時,就可以到Modify permissions下面檢查你的許可權。如果沒授予許可權的時候,status欄的consent會是一個藍色按鈕,按下即可。

 最後的Access Token,你可以複製它,用於測試,也可以點選大括號按鈕,去jwt.ms網站檢視token的具體內容。

 

 

 4. 查詢結果

首先最上面是查詢返回結果的狀態,常見的200,401,404.

Response preview。可以看到之前查詢的返回結果是23.

 

 Response headers

 

 Code snippets,這裡是對開發人員最有用的部分了。根據你的查詢,這裡會給出相應的C#,JavaScript的程式碼片段。但是要注意的是,不是任何查詢都給出程式碼片段的,個人感覺應該是最常用的一些查詢會有程式碼片段。

 

 Toolkit component 和 Adaptive cards也不是所有查詢都會有顯示結果。在開發中用到的機會也不多。

 

 以上就是Graph Explore使用介紹了,以後有機會再寫寫用Postman進行查詢測試的方法。

 

相關文章