Blazor でTodoist のデータにリアルタイムで連携するアプリを構築

杉本和也
杉本和也
リードエンジニア
ASP.NET Core Blazor C# でTodoist にSQL でクエリ。



Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってTodoist を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からTodoist に接続して直接SQL クエリを実行する方法を説明します。

Blazor はADO.NET Provider の利用が可能

CData ADO.NET Provider for API のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL(もしくはDapper などのORM を挟んでもいいです)であり、Todoist のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Todoist ADO.NET Data Provider で検索してください。

NuGet でADO.NET Todoist Provider をインストール

Blazor でTodoist にデータ連携するアプリを構築

Blazor にADO.NET Provider for API を接続

  • Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
  • Blazor アプリを作成
  • ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
  • 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for API 2019J\lib etstandard2.0」内のSystem.Data.CData.API.dll」を参照に選びます。
  • ADO.NET for API の.dll をBlazor アプリから参照

Blazor でTodoist のデータをSELECT

サンプルプロジェクトの「Page」→「Index.razor」を開きます。

以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Todoist 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for API の強味です。

      @page "/"
      @using System.Data;
      @using System.Data.CData.API;

      <h1>Hello, world!</h1>

      Welcome to your Data app.

      <div class="row">
          <div class="col-12">

              @using (APIConnection connection = new APIConnection(
                "Profile=C:\profiles\Todoist.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"))
              {
                  var sql = "SELECT Id, Priority FROM Tasks WHERE Completed = 'false'";
                  var results = new DataTable();

                  APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
                  dataAdapter.Fill(results);

                  <table class="table table-bordered">
                      <thead class="thead-light">
                          <tr>
                              @foreach (DataColumn item in results.Rows[0].Table.Columns)
                              {
                                  <th scope="col">@item.ColumnName</th>
                              }
                          </tr>
                      </thead>
                      <tbody>
                          @foreach (DataRow row in results.Rows)
                          {
                              <tr>
                                  @foreach (var column in row.ItemArray)
                                  {
                                      <td>@column.ToString()</td>
                                  }
                              </tr>
                          }
                      </tbody>
                  </table>
              }
          </div>
      </div>
    

まず、Profile 接続プロパティにTodoist プロファイルのディスク上の場所を設定します(例:C:\profiles\Todoist.apip)。次に、ProfileSettings 接続プロパティにTodoist の接続文字列を設定します(以下を参照)。

Todoist API プロファイル設定

Todoist に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。

まず、Todoist にOAuth アプリケーションを登録します。App Management Console に移動し、新しいアプリケーションを作成して有効なOAuth リダイレクトURL を設定します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。

以下の接続プロパティを設定すると、接続の準備が整います:

  • AuthScheme:OAuth に設定します。
  • InitiateOAuthGETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId:アプリ設定で指定されているclient_id を設定します。
  • OAuthClientSecret:アプリ設定で指定されているclient_secret を設定します。
  • CallbackURL:アプリ設定で指定されているRedirect URI を設定します。

プロジェクトをリビルドして実行します。このようにTodoist からデータを直接取得し、HTML テーブル形式にレンダリングしています。

Blazor アプリからTodoist のデータをクエリ

もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

まとめ

このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってTodoist にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。

はじめる準備はできましたか?

API Driver で Todoist のライブデータに接続

Todoist に接続 お問い合わせ