【徹底解説】Webflow とのデータ連携ができるMVC アプリケーションの作り方

加藤龍彦
加藤龍彦
デジタルマーケティング
複雑な開発が必要なMVC アプリからWebflow API とのデータ連携をノーコードで実現。接続→クエリ実行まで実装手順を詳細解説、API のアップデート追従も不要でWebアプリケーションの開発・保守を効率化できます。



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

Entity Framework Model の作成

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

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

  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 - 認可されたユーザーへの読み取りアクセス
  7. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is APIModel.
  8. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  9. Click New Connection. Select CData Webflow Data Source in the dialog that is displayed.

  10. Specify the required connection string properties. 一般的な接続文字列は次のとおりです。

    A typical connection string is below:

    Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

    The completed connection step in the ADO.NET Entity Data Model wizard. (A QuickBooks connection is shown.)
  12. 必要なテーブルおよびビューを選択します。ここでは、Sites をインポートしています。また、オブジェクト名を複数形に変換するオプションは、チェックをはずしています。［Finish］をクリックして.edmx ファイルを作成します。Tables to be imported into the .edmx file. (QuickBooks is shown.)
  13. プロジェクトをビルドして完成です。

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

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

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

  • Template：次のオプションを選択します：'Controller with read/write actions, using Entity Framework'.
  • Model class：Sites を選択。
  • Data context class：APIEntities を選択。
Creating a new Controller from an existing entity data model in the Add Controller dialog. (QuickBooks is shown.)

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

The Index view of the example MVC Web application. (QuickBooks is shown.)

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

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

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

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

コンテキストの作成

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

private APIEntities db = new APIEntities();

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

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

public ActionResult Index() { return View(db.Sites.ToList()); }

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

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

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

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

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

Webflow に接続

この記事の内容

関連記事