Entity Framework 6 からShort.io のデータに連携

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

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

   API キー認証の設定

   Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

   1. Short.io アカウントにログインします
   2. Settings > Integrations & API > API に移動します
   3. Create API Key をクリックして API キーをコピーします

   API キーを取得したら、接続を確立できます：

   • AuthScheme：APIKey に設定します。
   • APIKey：Settings > Integrations & API > API から取得した Short.io の API キーに設定します。

   接続文字列の例：

   Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

   利用可能なテーブル

   Short.io プロファイルでは、以下のテーブルにアクセスできます：

   • Domains - 認証済みアカウントに関連付けられた Short.io ドメイン
   • Links - ドメインの短縮リンク
   • LinkExpand - ドメインとパスから短縮リンクを展開
   • LinksByOriginalUrl - 指定した元の宛先 URL に一致する複数の短縮リンクを取得
   • Folders - 特定のドメイン内のリンクフォルダー
   • LinkPermissions - ドメイン内の特定のリンクの権限レコード
   • CountryTargeting - 特定の短縮リンクの国別リダイレクトターゲティングルール
   • RegionTargeting - 特定の短縮リンクの地域別リダイレクトターゲティングルール
   • Regions - 指定した国コードに対する利用可能な地域／州の一覧
   • DomainStatistics - Short.io ドメインのクリック数とトラフィックの集計統計
   • LinkStatistics - 特定の Short.io リンクのクリック数とトラフィックの集計統計

   
   <configuration>
      ... 
     <connectionStrings>
       <add name="APIContext" connectionString="Offline=False;Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';" 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 ファイルを作成し、ファイル名を呼び出そうとしているShort.io のエンティティ、例えばDomains にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

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

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

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

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

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