鍋綿ブログ

C#・SharePoint・SharePoint Framework・Office365を中心に扱うブログです。

Common Data ServiceのWeb APIを SharePoint Framework (SPFx) から実行するサンプル

Common Data Service (以下CDS) のWeb APIを操作する練習を兼ねて、これをSPFxで開発したWebパーツから実行してみました。APIを色々と試しながら実行できるように、Graph エクスプローラーを参考に「API実行を試せるWebパーツ」を目標にしました。
 

 

機能

f:id:micknabewata:20201005152842p:plain

画面イメージ - 実行画面

f:id:micknabewata:20201005152839p:plain

画面イメージ - サンプルリクエスト選択画面
  • HTTPメソッド、環境、エンドポイント、要求ヘッダ、要求本文を指定してWeb APIを実行
  • サンプルリクエストの選択

アピールポイント

  • API仕様が分からない時にWebパーツ上でトライ&エラーできる
  • 右も左も分からない時にサンプルリクエストを選択してとりあえず実行できる
  • UIを地味に多言語対応した(英語ユーザーが表示するとUIが英語になる)
  • 地味に地味に要求ヘッダの入力UIを工夫した

実装上の注意点

  • Webパーツへのアクセス許可の付与方法に注意。通常の方法(package-solution.jsonに記述)ではアクセス許可を与えられない。方法は下記サンプルコードのReadMeを参照。
  • ユーザーによってアクセス可能なCDSの「環境」が異なる可能性有。

サンプルコード

github.com