REST API エクスペリエンスに対する更新プログラムの発表
この記事は、docs.microsoft.com チームのプログラム部長である Jessie Huang によって執筆されました。
本日は、docs.microsoft.com の REST エクスペリエンスに対する、次の 2 つの重要な機能強化のリリースについてお知らせします。
- REST API ブラウザーのプレビュー バージョン: Microsoft が開発した REST API を簡単に検索して検出できます。
- REST Try It: 任意の Web ブラウザーで REST API を直接試すことができる対話型のエクスペリエンスです。
1 つの場所で REST API を検出する
.NET、PowerShell、Python、JavaScript など、既存の API ブラウザー エクスペリエンスに既に精通している場合は、この新しいリリースをすぐに利用できます。これにより、あまり重点が置かれていない検索エクスペリエンスに依存することなく、さまざまな REST API のドキュメントをすばやく取得できます。 API ブラウザーによって適切な API をすばやく見つけることができ、効率化が図れます。
以前は、docs.microsoft.com で特定の REST API ドキュメントを検索する場合は、サイト全体の検索で検索するか、目次などのコンテンツ ページで任意のナビゲーション コンポーネントを使用する必要がありました。 特に、探す情報が厳密にわかっている状況では、時間がかかる場合があります。 もっと簡単にしたいと思いました。
今日から、1 つの一元化された場所 https://docs.microsoft.com/rest/api で、はるかに効率的な方法で Microsoft REST API を見つけることができます。 ドロップダウンからサービスを選択するだけで、利用可能なすべてのサービス API を検索できます。
クリックを保存する必要がありますか? 使用頻繁の高い API のいくつかについて、いつでもクイック フィルターを利用できます。そのうちの 1 つをクリックすると、所定のサービスの包括的な API セットの最新リリースが、すぐに見つかります。
検索エクスペリエンスは、厳密なキーワードを知っているかどうかに関わらず、あるいはそのサービスを知らない場合でも、必要な API 情報を見つけることができるように設計されています。 既定では、docs.microsoft.com にあるすべての API ドキュメントを検索します。 サービスが選択されている場合にのみ、そのサービスのスコープ内で検索が行われます。
一度に複数のキーワードを検索する必要がありますか? それもできます。
ブラウザーで Azure REST API を使ってみる
関心のある Azure API が見つかったものの、シナリオの構築に役立つものかどうかがわかりませんか? 心配は不要です。今日から、docs.microsoft.com にアクセスして、ブラウザーで直接 Azure REST API を使ってみることができます。
必要なのは、緑色の [使ってみる] ボタンを押すことだけです。
REST API の [使ってみる] を選択すると、フォーカスされたビューが表示され、さまざまなパラメーター値や要求本文を使ってみることができます。 ページの左上隅にある [コンテンツ] ハンバーガー メニューを使用して、記事のコンテキストを簡単に変更できます。
フィードバックをお寄せください
近日実装する予定の機能強化が多数あり、このエクスペリエンスは最終的なものではありません。たとえば、Azure REST API 以外でも、[使ってみる] を有効にする予定です。 REST をより良くするためのご意見をお待ちしております。新しい問題を登録してください。できるだけ早く返信いたします。
Twitter アカウントでも最新の更新情報や通知をお伝えしています。
開発者にとってより良い世界にしたいとお考えですか? ぜひチームにご参加ください!