本文將協助您開始使用 Microsoft Learn 目錄 API 搭配 curl 和 Visual Studio Code。 如果您不熟悉 API 的詳細數據或其使用案例,建議您先檢閱 Learn 目錄 API 功能概觀一文。
我們將講解的高階流程如下:
- 查詢 Learn 目錄 API
- 檢閱初始回應
- 美化〈回應〉
- 將它轉換成試算表
- 嘗試更多查詢
一旦您開始針對自己的需求使用 Learn 目錄 API,可能會發現自己稍微修改這些步驟,以符合您所需的工具組或需求,但一般而言,在所有使用情境中,整體使用流程大同小異。
先決條件
若要遵循本文中的步驟,您需要 curl 和 Visual Studio Code,這是兩個熱門的免費查詢 API 工具。
- 如果您已安裝 curl 和 Visual Studio Code,您可以直接跳到查詢 Learn 類別目錄 API 一節。
- 如果您沒有安裝它們,請遵循下列各節中的指示。
下載並設定 curl
curl 是一種熱門、免費、開放原始碼、命令行工具,可查詢 API。
- 移至 curl 下載頁面 並下載適用於您環境的套件。 如果您不確定要挑選哪一個,請使用 curl 下載精靈。
- 安裝應用程式並遵循提示進行設定。 本文或查詢 Learn 目錄 API 不需要特定的設定。
下載並設定 Visual Studio Code
Visual Studio Code 是Microsoft所建立的免費功能強大的程式碼編輯器。
- 移至 Visual Studio Code 網站 並下載適用於您環境的套件。
- 安裝應用程式並遵循提示進行設定。
查詢「Learn」目錄 API
因為不需要驗證才能使用 Learn 目錄 API,因此您可以從已啟用 curl 的任何命令行查詢 API 端點。 在此練習中,我們將使用 Visual Studio Code 內的終端機。
- 開啟 Visual Studio Code。
- 選取頂端導覽中的 [終端機]。
- 選取 [新增終端機] 以開啟新的命令終端機。
- 挑選您選擇的終端機(Bash、CMD 等),然後輸入下列命令。 下列命令表示它要使用 curl,呼叫未篩選的 Learn Catalog API 端點,並將回應輸出到一個名為「output.json」的檔案,該檔案的位置由終端機中顯示的檔案路徑(例如:
C:\Users\<username>
)決定。
curl https://learn.microsoft.com/api/catalog >> output.json
- 如果要求成功,您應該會看到檔案大小總計的相關信息,例如 13.1 M(視回應的大小而定,大小可能會變更)。 如果失敗,您應該會收到錯誤訊息。
備註
使用 output.json 檔案之後,您應該刪除該檔案,或將它重新命名為更適用。 如果您使用相同的檔名再次查詢 API,它會在現有檔案中附加回應。 另一個選項是在初始查詢命令期間更唯一地命名檔案,例如 「output-1212.json」 或 「output-de-de-2022-12-12.json」。
檢閱初始回應
初始回應在 JSON 中,且會「最小化」,這表示會移除特定空格、行和索引標籤,讓檔案更小。
- 在 Visual Studio Code 中,選取 [檔案]。
- 選取 [開啟檔案]。
- 流覽至上一節中建立的 「output.json」 檔案。
此最小化是一種標準做法,而且檔案可透過Visual Studio Code中的命令「美化」來更容易閱讀,我們將在下一節中執行此動作。
美化回應
- 在 Visual Studio Code 中開啟 「output.json」 檔案時,請使用 Ctrl+Shift+I。
JSON 應更新為分割成多行,且格式更易讀。 如需瞭解回應中不同屬性和數值的相關信息,請參閱 Learn 目錄 API 開發人員參考文章的 數據字典。
將回應轉換為試算表
有許多人員使用 Learn 目錄 API 進行個別工作或檢閱,而不是將它整合到系統中。 針對這些使用案例,將 JSON 回應轉換成 CSV 或 Excel 格式以查看為試算表可能很有幫助。 您可以使用任何慣用的轉換工具,但在這裡,我們可以使用 Flatfile Json 至 CSV 轉換程式。
- 移至:https://csvjson.com/json2csv。
- 上傳輸出檔案。
- 選取 [轉換]。
- 選取 [下載]。
注意
請非常小心使用外部在線工具來轉換數據,並考慮您要放入的數據。 在 Learn 目錄 API 的情況下,回應是公開可用的,不需要驗證,因此可以使用線上工具來協助轉換格式。
嘗試更多查詢
請遵循上述步驟來嘗試更多查詢,例如下面所列的查詢。 檢視每個回應檔大小變更的方式,以及 其中對象的差異。
描述 | 查詢 |
---|---|
"Learn" 目錄 API 中的所有項目 | https://learn.microsoft.com/api/catalog/ |
所有西班牙文模組 | https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules |
所有熱門分數為 0.9 或更高的模組 | https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9 |
所有初學者安全性訓練和認證物件 | https://learn.microsoft.com/api/catalog/?level=beginner&subject=security |
所有進階輔助功能模組,其熱門分數超過 0.5,並在上個月更新 | https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01 |
後續步驟
建議您檢閱下列資源,以協助您進行開發旅程: