Entity Framework 6 からWebflow のデータに連携

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでWebflow にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Webflow Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   認証

   Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。

   OAuth 2.0 のセットアップと設定

   ステップ 1：Webflow OAuth アプリケーションの作成

   OAuth 認証をセットアップするには、以下のステップで進めます：

   1. Webflow Developer Portal にアクセスします
   2. Webflow アカウントの「Apps & Integrations」に移動します
   3. 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
   4. アプリケーション名、説明、リダイレクト URI（CallbackURL）を設定します
   5. 接続で使用する Client ID と Client Secret をコピーします

   必須の接続プロパティ

   • AuthScheme：OAuth に設定します（必須）
   • OAuthClientId：Webflow OAuth アプリケーションの Client ID（必須）
   • OAuthClientSecret：Webflow OAuth アプリケーションの Client Secret（必須）
   • CallbackURL：OAuth アプリケーションで指定したリダイレクト URI（必須）
   • InitiateOAuth：トークンを自動管理するには GETANDREFRESH に設定します（推奨）

   必須の OAuth スコープ

   Webflow API プロファイルでは、以下の OAuth スコープが必要です：

   • sites:read - サイト情報および設定への読み取りアクセス
   • pages:read - サイトページへの読み取りアクセス
   • cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
   • forms:read - フォームおよびフォーム送信への読み取りアクセス
   • assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
   • ecommerce:read - 製品、注文、在庫への読み取りアクセス
   • authorized_user:read - 認可されたユーザーへの読み取りアクセス

   
   <configuration>
      ... 
     <connectionStrings>
       <add name="APIContext" connectionString="Offline=False;Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;" providerName="System.Data.CData.API" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.API" type="System.Data.CData.API.APIProviderServices, System.Data.CData.API.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.API.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAPIContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class APIContext :DbContext {
   	public APIContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<APIContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているWebflow のエンティティ、例えばSites にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Sites {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String  { get; set; }
   }
   public class SitesMap :EntityTypeConfiguration<Sites> {
   	public SitesMap() {
   		this.ToTable("Sites");
   		this.HasKey(Sites => Sites.Id);
   		this.Property(Sites => Sites.);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<Sites> Sites { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   APIContext context = new APIContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Sites select line;