ASP.NET Web API は、ブラウザやモバイルデバイスなどの幅広いクライアントに届くHTTPサービスを容易に構築するためのフレームワークです。ASP.NET Web APIは、.NET Framework上でRESTfulアプリケーションを構築するための理想的なプラットフォームです。ComponentOne Web API は、FlexChart、Gauge、Imageのエクスポート、およびFlexGridを使用するExcelシートのインポートとエクスポートを可能にする一連のAPIです。このAPIは、Web API 2.2とASP.NET CoreをサポートするVisual Studioテンプレートとして利用できます。
このトピックでは、Web APIサービスアプリケーションをVisualStudioで作成し、IIS上に展開する（またはセルフホストする）方法について説明します。これにより、クライアントアプリケーションに対するサーバー側（エンドポイント）が構築されます。クライアントアプリケーションは、サービスにアクセスするためにエンドポイントに要求を送信し、応答を受信します。
- Visual Studio では、［ファイル］→［新規作成］→［プロジェクト］を選択して、新しいWeb APIサービスプロジェクトを作成します。
- インストール済みテンプレートから、［C1］→［Web］→［C1 Web API アプリケーション］を選択して、新しいComponentOne Web APIサービスアプリケーションを作成します。
- アプリケーションの[名前]および[場所]を設定します。
-
ComponentOne ASP.NET Web APIアプリケーションウィザードで、プロジェクト要件に従ってWeb APIサービスを選択します。
- ウィザードから[サービス]を選択したら、[OK]をクリックして新しいComponentOne Web APIサービスアプリケーションを作成します。詳細については、サービストピックを参照してください。
ComponentOneテンプレートは、この新しいプロジェクトに、C1.Web.Api.dll、C1.C1Excel.dllなどの関連アセンブリへの参照を追加します。 - 構成されたリモートまたはローカルストレージのデータをアクセスすることができます。ローカルストレージを構成する方法のためにストレージの設定、サーバー側の接続文字列の設定、.NETコレクションの設定を参照してください。
- これでサービスプロジェクトを設定できました。プロジェクトをIIS上に展開するか（IISでホストされるサービスアプリケーションの場合）、単にアプリケーションを実行して（セルフホストされる場合）、使用を開始します。
- Visual Studio を開き、［ファイル］→［新規作成］→［プロジェクト］を選択して、新しいWeb APIサービスプロジェクトを作成します。
- インストール済みテンプレートから、［C1］→［Web］→［C1 Web APIのASP.NET Coreアプリケーション］を選択します。
- アプリケーションの[名前]および[場所]を設定します。
- 構成されたリモートまたはローカルストレージのデータをアクセスすることができます。ローカルストレージを構成する方法のためにストレージの設定、サーバー側の接続文字列の設定、.NETコレクションの設定を参照してください。
- ランタイムライセンスをアプリケーションに追加します。
- Visual Studioでアプリケーションを実行します。
ComponentOneテンプレートは、この新しいプロジェクトに、C1.Web.Api.dll、C1.C1Excel.dllなどの関連アセンブリへの参照を追加します。
サーバー側が作成されます。これで、起動したWebAPI サービスに対して生成されたURLを使用して、クライアントアプリケーションからサービスプロジェクトを呼び出すことができます。クライアントアプリケーションで、レポート、Excel、画像、バーコードなどのWeb APIサービスを使用できます。詳細については、「サービス」を参照してください。
次の画像は、ホストされているWeb APIサービスアプリケーションを示します。
上の例では、サービスは、https://demo.mescius.jp/c1/aspnet/webapiexplorer/ でホストされています。
Web API URL for Servicesを正常にホストできたら、これらのWeb APIサービスにアクセスして呼び出し、ExcelファイルやExcel画像のエクスポートとインポート、指定したデータとテンプレートからのExcelの生成、指定したテキストからのバーコードの生成を行うことができます。Web APIサービスの操作方法については、「サービス」トピックを参照してください。