Microsoft Graphことはじめ クエリパラメータ編
Download as PPTX, PDF0 likes806 views
2019年9月の.Netラボで発表した内容の資料です。
Microsoft Graphことはじめ クエリパラメータ編
- 2. 誰？ @DevTakas Angular / Azure / .Net Core / Azure DevOps / Microsoft Graph
- 5. Graph APIの何が嬉しいのか • データ間の繋がりがわかりやすくなっている • 従来はサービスが違えばAPIエンドポイントも違ってた • 例）ユーザーとユーザーの予定情報を参照したい • 従来のREST APIの場合はそれぞれ単独のAPIから呼び出している • 例:ユーザー情報)GET http://example.com/user/{user-id} • 例:予定情報)GET http://example.com/event?userId={user-id} • Graphの場合は「ユーザーに紐づく情報」のイメージで呼び出せる • 例:ユーザー情報)GET http://example.com/user/{user-id} • 例:予定情報)GET http://example.com/user/{user-id}/event
- 6. • 単一の塊として表現されてきたデータに繋がりが生まれた Graph APIの何が嬉しいのか ユーザー メッセージ カレンダー 単独リソースで完結しているので データの繋がりがわかりにくい ユーザー メッセージ カレンダー 添付ﾌｧｲﾙ 添付ﾌｧｲﾙ URLでデータの繋がりが表されているので わかりやすい
- 7. Graph APIの何が嬉しいのか • 単一の塊として表現されてきたデータに繋がりが生まれた • サービス間の繋がりが生まれた • 例えばMSのGraphの「ユーザー」を起点にして 様々な情報を直感的に取得することが可能となる • Message: メール(Outlook)の情報(/users/{id}/message) • Events:予定(Outlook)の情報(/users/{id}/events) • Drive:Drive(Onedrive)の情報(/users/{id}/drive) • 「誰」の「〇〇」の情報がURLで判断できる
- 9. Microsoft Graphをより便利に使うために • クエリパラメータを使用しレスポンスを制御できる • 主なクエリオプション • Count：返却されるリソース総数を取得 • Expand：関連リソースを取得 • Filter：結果をフィルタリング • Format：返却メディア形式を指定 • Orderby：結果の並べかえ • Select：返却列フィルタ • Skip：結果にIndexを付与。ページングとセットで使用される • Top：結果ページのサイズを指定する
- 10. Microsoft Graphをより便利に使うために • クエリオプションの何が嬉しい？ • WebAPIから整形されたデータが返却される • 従来のAPIはレスポンスをコントロールできない • 必要不必要に関わらず常に同一のデータが返却される • 通信で返却されるパラメータの8割は使わんなんてこともザラ • 良し悪しはある… • でかいデータ→フロントエンドで加工みたいなのがなくなる • データ通信量の削減、処理スピードのアップ • 柔軟な絞り込みを通信前段階で行える
- 11. Microsoft Graphをより便利に使うために • データ通信量の削減、処理スピードのアップ • 👈Messagesのプロパティ。 • 全てのプロパティを使うことはまずない。 • 何も指定しないとこの情報が全部振ってくる。無駄。 • (しかもこの中にメッセージのHTML入ったりしてる) https://docs.microsoft.com/ja-jp/graph/api/resources/message?view=graph-rest-1.0 より
- 12. Microsoft Graphをより便利に使うために • 柔軟な絞り込みを通信前段階で行える • WebAPIの絞り込みの条件はWebAPIの仕様に依存していた • 日付のFromとToだけ？未読だけでいいんだけど…とか • ドカッとデータ落としてフロントでフィルタリングみたいな… • $filterを使えば提供されているプロパティ情報で絞り込める Web API クエリパラメータはfromとtoがあるよ (それしか使えない) Graph API 絞り込み条件を指定してね
- 13. Microsoft Graphをより便利に使うために • 関連リソースのデータを取得できる • $expand • リソースの子リソースの情報を取得したりできる • 例えばメールに対する添付ファイル情報とか… • 複数のAPIアクセスを流さなくて良いのが嬉しい • Beta版のみでしか使えないもの等があるのでドキュメント参照は必須 • https://docs.microsoft.com/ja-jp/graph/query-parameters#expand-parameter
- 14. Microsoft Graphをより便利に使うために • $expand(例：メール) • Expandで参照できるリソースは「リレーションシップ」を参照する • 例えばメールの/messages/からは添付ファイルリソースを参照できる https://docs.microsoft.com/ja-jp/graph/api/resources/message?view=graph-rest-1.0 より
- 15. Microsoft Graphをより便利に使うために • $expand(例：メール) • Expandで参照できるリソースは「リレーションシップ」を参照する • 先述の通りBetaでしか使えなかったり、全てのリレーションシップで expandがサポートされているわけではない https://docs.microsoft.com/ja-jp/graph/query-parameters#expand-parameter より
- 17. Microsoft Graphをより便利に使うために • Graph Graph API クエリオプション付きでリクエスト 必要最低限のデータ必要最低限の フロント 加工 利用
- 18. Microsoft Graphをより便利に使うために • クエリオプションの動作を見てみよう • Filter • Orderby • Select • Skip • Top • Expand
- 19. Microsoft Graphことはじめ まとめ • ユーザー情報等の取得にGraphはめっちゃ便利 • クエリオプションを使うともっと便利
- 20. 参考文献 • Microsoft Graph でのユーザーの操作 • https://docs.microsoft.com/ja-jp/graph/api/resources/users?view=graph-rest-1.0 • クエリ パラメーターを使用して応答をカスタマイズする • https://docs.microsoft.com/ja-jp/graph/query-parameters?view=graph-rest-1.0 • OData Version 4.0. Part 2: URL Conventions Plus Errata 03 - QueryOption • https://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2- url-conventions-complete.html#_Toc453752356 • メッセージ リソースの種類 • https://docs.microsoft.com/ja-jp/graph/api/resources/message?view=graph-rest-1.0 • Expandパラメータ • https://docs.microsoft.com/ja-jp/graph/query-parameters#expand-parameter • 添付ファイルを取得する • https://docs.microsoft.com/ja-jp/graph/api/attachment-get?view=graph-rest-1.0&tabs=http