次の方法で共有


curl と Visual Studio Code を使用して Microsoft Learn Catalog API を始めよう

この記事では、curl と Visual Studio Code で Microsoft Learn Catalog API の使用を開始する際に役立つ情報を提供します。 API の詳細やユース ケースに慣れていない場合は、まず、Learn Catalog API 機能の概要に関する記事 確認することをお勧めします。

全体のプロセスの概要は次のとおりです。

  1. Learn Catalog API のクエリを実行する
  2. 最初の応答を確認する
  3. 応答を "Prettify" する
  4. スプレッドシートに変換する
  5. その他のクエリを試す

Learn Catalog API を自分のニーズに合わせて使用し始めると、必要なツールセットやニーズに合わせてこれらの手順を少し変更する場合がありますが、一般的に使用するプロセスはすべてのユース ケースで同じです。

前提 条件

この記事の手順に従うには、curl と Visual Studio Code (API のクエリを実行するための 2 つの一般的な無料ツール) が必要です。

  • curl と Visual Studio Code が既にインストールされている場合は、「Learn Catalog API のクエリ」セクションに進んでください。
  • インストールされていない場合は、次のセクションの手順に従います。

curl をダウンロードしてセットアップする

curl は、API にクエリを実行できる、一般的で無料のオープンソースのコマンド ライン ツールです。

  1. curl ダウンロード ページ に移動し、環境に該当するパッケージをダウンロードします。 選択するファイルがわからない場合は、curl ダウンロード ウィザードを使用します。
  2. アプリケーションをインストールし、プロンプトに従って構成します。 この記事や Learn Catalog API のクエリには、一意の設定は必要ありません。

Visual Studio Code をダウンロードしてセットアップする

Visual Studio Code は、Microsoft によって作成された無料の強力なコード エディターです。

  1. Visual Studio Code サイト に移動し、環境に該当するパッケージをダウンロードします。
  2. アプリケーションをインストールし、プロンプトに従って構成します。

Learn Catalog API のクエリを実行する

Learn Catalog API を使用するために認証は必要ないため、curl 対応の任意のコマンド ラインから API エンドポイントに対してクエリを実行できます。 この演習では、Visual Studio Code 内でターミナルを使用します。

  1. Visual Studio Code を開きます。
  2. 上部のナビゲーションで [ターミナル] を選択します。
  3. [新しいターミナル] を選択して、新しいコマンド ターミナルを開きます。
  4. 任意のターミナル (Bash、CMD など) を選択し、次のコマンドを入力します。 次のコマンドは、curl を使用し、フィルター処理されていない Learn Catalog API エンドポイントを呼び出し、ターミナル (例: C:\Users\<username>) に示されているファイルパスで定義された場所に"output.json"という名前のファイルに応答を出力することを示しています。
curl https://learn.microsoft.com/api/catalog >> output.json
  1. 要求が成功した場合は、ファイルの合計サイズに関する情報 (13.1 M など) が表示されます (サイズは応答のサイズに応じて変更される可能性があります)。 失敗した場合は、エラーが表示されます。

手記

output.json ファイルの使用が完了したら削除するか、より適切な名前に変更する必要があります。 同じファイル名を使用して API に再度クエリを実行すると、既存のファイル内に応答が追加されます。 もう 1 つのオプションは、"output-1212.json" や "output-de-de-2022-12-12.json" など、最初のクエリ コマンド中にファイルに一意の名前を付ける方法です。

最初の応答を確認する

最初の応答は JSON であり、"最小化" されます。つまり、ファイルを小さくするために特定のスペース、行、タブが削除されます。

  1. Visual Studio Code で、[ファイル] を選択します。
  2. [ファイルを開く] を選択します。
  3. 前のセクションの一部として作成された "output.json" ファイルに移動します。

この最小化は標準的な方法であり、Visual Studio Code のコマンドで読みやすくするためにファイルを "事前設定" できます。これは、次のセクションで行います。

応答を事前設定する

  1. Visual Studio Code で "output.json" ファイルを開いた状態で、Ctrl + Shift + I キーを押します。

JSON は、複数の行に分割され、読みやすい形式に更新されます。 応答内のさまざまなプロパティと値については、データ ディクショナリの Learn Catalog API 開発者向けリファレンス記事を参照してください。

応答をスプレッドシートに変換する

Learn Catalog API は、システムに統合するのではなく、個々のタスクやレビューに使用するユーザーが多数います。 このようなユース ケースでは、JSON 応答を CSV または Excel 形式に変換してスプレッドシートとして表示すると便利な場合があります。 任意の優先変換ツールを使用できますが、ここでは、Flatfile Json から CSV へのコンバーターを使用できます。

  1. 移動: https://csvjson.com/json2csv.
  2. 出力ファイルをアップロードします。
  3. [変換] を選択します。
  4. [ダウンロード] を選択します。

手記

外部オンライン ツールを使用してデータを変換し、どのようなデータをデータに入れているかを十分に注意してください。 Learn Catalog API の場合、応答は一般公開されており、認証は必要ないため、オンライン ツールを使用して形式の変換に役立てることもできます。

その他のクエリを試す

上記の手順に従って、以下に示すようなクエリをさらに試してください。 応答ファイルのサイズがそれぞれの変化と、その中のオブジェクトの違いを確認します。

説明 クエリ
Learn Catalog 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

次の手順

開発の過程で役立つ以下のリソースを確認することをお勧めします。