使用 cURL 和 Visual Studio Code 以開始使用 Microsoft Learn 目錄 API

本文將協助您開始使用 Microsoft Learn 目錄 API 搭配 curl 和 Visual Studio Code。 如果您不熟悉 API 的詳細資料或其使用案例，建議您先檢閱 Learn 目錄 API 功能概觀一文。

我們將逐步解說的高階程序如下:

1. 查詢 Learn 目錄 API
2. 檢閱初始回應
3. 「美化」 回應
4. 將它轉換成試算表
5. 試用更多查詢

一旦您開始針對自己的需求使用 Learn 目錄 API，您可能會稍微修改這些步驟，以符合您所需的工具組或需求，但一般而言，針對所有使用案例，使用這些步驟的程序都相同。

必要條件

若要遵循本文中的步驟，您需要 curl 和 Visual Studio Code，這是兩個熱門的免費查詢 API 工具。

• 如果您已安裝 curl 和 Visual Studio Code，您可以直接跳到查詢 Learn 類別目錄 API 一節。
• 如果您尚未安裝它們，請遵循下列各節中的指示。

下載並設定 curl

curl 是熱門、免費、開放原始碼的命令列工具，可查詢 API。

1. 移至 curl 下載頁面 並下載適用于您環境的套件。 如果您不確定要挑選哪一個，請使用 curl 下載精靈。
2. 安裝應用程式並遵循提示進行設定。 針對本文或查詢 Learn 目錄 API 不需要唯一的設定。

下載並設定 Visual Studio Code

Visual Studio Code 是 Microsoft 所建立的免費、功能強大的程式碼編輯器。

1. 移至 Visual Studio Code 網站，並下載適用于您環境的套件。
2. 安裝應用程式並遵循提示進行設定。

查詢 Learn 目錄 API

因為不需要驗證即可使用 Learn 目錄 API，因此您可以從已啟用 curl 的任何命令列查詢 API 端點。 在此練習中，我們將使用 Visual Studio Code 內的終端。

1. 打開 Visual Studio Code。
2. 選取頂端導覽中的 [終端]。
3. 選取 [新增終端] 以開啟新的命令終端。
4. 挑選您選擇的終端 (Bash、CMD 等)，然後輸入下列命令。 下列命令指出其想要使用 curl、呼叫未篩選的 Learn 目錄 API 端點，並將回應輸出至終端所顯示之檔案路徑中所定義之檔案「output.json」 的回應 (例如: C:\Users\<username>):

curl https://video2.skills-academy.com/api/catalog >> output.json

1. 如果要求成功，您應該會看到檔案大小總計的相關資訊，例如 13.1 M (視回應的大小而定，尺寸可能會變更)。 如果失敗，您應該會收到錯誤。

檢閱初始回應

初始回應在 JSON 中，且會「最小化」，這表示會移除特定空格、行列和索引標籤，讓檔案更小。

1. 在 Visual Studio Code 中，選取 [檔案]。
2. 選取 [開啟檔案]。
3. 瀏覽至上一節中建立的「output.json」檔案。

此最小化是一種標準做法，而且檔案可透過 Visual Studio Code 中的命令「美化」，使之更容易閱讀，我們將在下一節中執行此動作。

美化回應

1. 在 Visual Studio Code 中開啟「output.json」檔案時，請使用 Ctrl+Shift+I。

JSON 應更新為分割成多行，且更易讀取的格式。 如需回應中不同屬性和值的相關資訊，請檢視 Learn 目錄 API 開發人員參考文章 以獲取資料字典。

將回應轉換為試算表

有許多人員使用 Learn 目錄 API 進行個別工作或檢閱，而非將它整合到系統中。 針對這些使用案例，將 JSON 回應轉換成 CSV 或 Excel 格式以檢視為試算表可能很實用。 您可以使用任何慣用的轉換工具，但在這裡，我們可以使用 Flatfile Json 為 CSV 轉換器。

1. 移至: https://csvjson.com/json2csv。
2. 上傳輸出檔案。
3. 選取轉換。
4. 選取 [下載]。

試用更多查詢

請遵循上述步驟來嘗試更多查詢，例如下面所列的查詢。 檢視每個回應檔案大小變更的方式，以及其中物件的差異。

下一步

我們建議檢閱下列資源，以協助您在開發旅程中前進:

• Learn 目錄 API 開發人員參考
• Learn 目錄 API 最佳做法
• Learn 目錄 API 常見問題
• Learn 目錄 API 版本資訊