PayPal とのデータ連携ができるMVC アプリケーションの作成

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

この記事では、Visual Studio のウィザードを使って簡単なMVC（モデル・ビュー・コントローラ）プロジェクトを作成し、Entity Framework のメソッドを使うPayPal にcreate, read, update, delete (CRUD) コマンドクエリを実行する方法を説明します。

Entity Framework Model の作成

下記の手順に従って接続プロパティを保存し、データモデルのエンティティにテーブルをマップします。

1. Entity Framework 6 をお使いの場合は、あらかじめプロジェクトに PayPal Entity Framework プロバイダーを登録してください。詳しくは、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。
2. Visual Studio で新規MVC プロジェクトを作成［Internet Application］テンプレート、［Razor］ビューエンジンを選択します。この例では、プロジェクト名はMvcPayPalApp です。
3. デザイナーから.edmx ファイルを追加するには、［プロジェクト］>［新しい項目の追加］をクリックします。ADO.NET Entity Data Model を選択してモデルに名前を付けたら［追加］をクリックします。この例では、モデル名はPayPalModel です。
4. ［Entity Data Model］ウィザードで、［EF Designer from database］オプションを選択します。［Entity Data Model］ウィザードが表示されます。
5. ［New Connection］をクリックします。ダイアログが表示されたらCData PayPal データソースを選択します。

6. 必要な接続文字列プロパティを指定します。

   CData 製品は、2つのPayPal API のテーブルを表示します。API は異なる認証方法を使用します。

   • REST API はOAuth 標準を使用します。REST API を認証するには、OAuthClientId、OAuthClientSecret、CallbackURL プロパティを設定する必要があります。
   • Classic API にはSignature API 認証情報が必要です。Classic API を認証するにはUsername、Password、およびSignature プロパティを設定する必要があります。

   必要なAPI 資格情報の取得については、ヘルプドキュメントの「はじめに」を参照してください。

   使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。デフォルトでは、SOAP スキーマが使われます。

   テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報を使用できます。

   一般的な接続文字列は次のとおりです。

   Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;

7. 接続に名前を付け、資格情報などのセンシティブ情報を接続文字列に含めるかどうかを選択します。簡略化のため、この例ではセンシティブ情報をWeb.config に保存しています。

8. 必要なテーブルおよびビューを選択します。ここでは、Transactions をインポートしています。また、オブジェクト名を複数形に変換するオプションは、チェックをはずしています。［Finish］をクリックして.edmx ファイルを作成します。
9. プロジェクトをビルドして完成です。

コントローラーの作成およびメソッドとビューの生成

モデルの作成とプロジェクトのビルドが終わったら、以下の手順に従ってコントローラー、ビュー、および関連するCRUD メソッドを作成できます。 Transactions テーブルに許可されたすべてのアクションのビューは、［Views］フォルダ内のTransactions サブフォルダに.cshtml ファイルとして格納されます。

［ソリューション エクスプローラー］で［Controllers］フォルダを右クリックし、［追加］>［コントローラー］をクリックします。コントローラーにPayPalController のような名前を付け、以下のオプションを設定します。

• Template：次のオプションを選択します：'Controller with read/write actions, using Entity Framework'.
• Model class：Transactions を選択。
• Data context class：PayPalEntities を選択。

これで、プロジェクトを実行できます。［Index］ビューにアクセスするには、"PayPal" をURL に追加します。

一からコントローラーを作成

このセクションでは、ほんの数行のコードでCRUD コマンドクエリをインプリメントする方法について説明します。利用可能なウィザードは、各ステップで詳しく説明します。

このチュートリアルを始める前に、エンティティデータモデルを作成しておいてください。PayPal へのコマンドを実行するために、コンテキストクラスのメソッドを使用していきます。［Entity Framework Data Model］ウィザードを使ってモデルを作成する方法については、前のセクションをご参照ください。 — これはモデルファーストアプローチです。 コードファーストアプローチの利用に関する詳細は、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。

1. 次の例のPayPalController のようにコントローラーを手動で作成するには、［ソリューション エクスプローラー］で［Controllers］フォルダを右クリックし、［追加］>［コントローラー］をクリックします。
2. ［Add Controller］ダイアログが表示されたら、［Template］メニューから'Controller with empty read/write actions' オプションを選択します。［Controller］フォルダ内にPayPalController.cs が作成されます。

コンテキストの作成

以下のコードを追加し、コンテキストクラスをクラス変数としてインスタンスを生成します。この簡単な例では、コントローラーはコンテキストクラスのメソッドを直接呼び出してCRUD コマンドを実行します。

PayPal データエンティティの取得

レコードのリストをビューに表示するには、Index メソッドを以下のように書き換えます。このコードは、コンテキストクラスのToList() メソッドを呼び出して、レコードテーブルを表示するビューを返します。デフォルトでは、Index メソッドは空のビューを返します。

ビューを作成するには、Index メソッド内を右クリックし、［Add View］をクリックします。ウィザードが表示されたら新しいビューIndex.cshtml を作成します。作成されたビューは［Views］フォルダに格納されます。このビューをロードするには、.cshtml ファイルを右クリックして［View In Page Inspector］をクリックします。

［Add View］ダイアログでビューに名前を付け、以下のオプションを設定します：

• Create a strongly typed view：このオプションを選択し、Transactions タイプのビューを作成。
• Model class：Transactions エンティティ、Transactions を選択。
• Scaffold template：［List］を選択。このメニューオプションは、エンティティを表示するHTML テーブルを生成します。