詳しくはこちら
 

API Server の製品概要

記事の内容

関連記事


API Server はインストールタイプのアプリケーションで、オンプレミスおよびクラウドデータをカスタムREST API として公開します。 本記事は、CData API Server の製品および機能についての概要説明です。

内容

API Server は何をするソフトウェアですか？

API Serverは、さまざまなデータソースに対して統一されたAPI を作ることを可能にします。GUI による簡単な操作だけで、データソースへの接続を確立し、超高速でREST API を作ることができます。 データソースはRDBMS 、ファイルフォーマット（CSV/TSV、JSON、etc.）、オンプレミスソフトウェア（QuickBooks、MS Excel、MS Access、etc.）、NoSQL、SaaS などに対応しています。API Server は、あなたのサーバーにインストールされるため、簡単にローカルおよびリモートでのAPI へのアクセスが可能です。

API Server が生成するAPI はどのようなAPI ですか？

API Server は、デフォルトでOData プロトコルのAPI を生成します。OData 規格は多くのBI、帳票、ETL ツールや一般の開発フレームワークやライブラリで最も使われている規格です。 API Server にデータソースを接続して、API として公開するリソースを設定するだけで、HTTP リクエストを送るだけでデータの読み書きが可能です。 OData をネイティブでサポートするBI、帳票、ETL ツールからはHTTP リクエストを発行・送信するプロセスはバックグラウンドで行われます。 プログラミングでリクエストを送信する場合には、API Server の［API］ページで使用可能なエンドポイントや操作を行うためのHTTP メソッドを参照できます。

API Server は、リソースのエンドポイントのメタデータを発見し、自動的にエンドポイントを生成します。 同時にSwagger エンドポイントも作成し、Swagger に対応するツール、サービス、ライブラリへのシームレスな連携を実現します。 API Server に追加したリソース毎に個別のエンドポイントが生成され、独立してデータ操作が可能です。 例えば、Salesforce をデータソースとしてAPI Server に設定し、Account 情報をリソースに登録した場合には、次のURL のようなHTTP リクエストをAPI Server に投げることで Salesforce のAccount データを操作できます: http://address:port/api.rsc/Salesforce_Account

サポートされるOData 機能

API Server は、次のOData 4.0 標準のURL パラメータをサポートします:

  • $filter
  • $expand
  • $select
  • $orderby
  • $top
  • $skip
  • $inlinecount
  • $count
  • $format

API Server はOData リクエストを受け取り、ベースとなるデータソースのネイティブプロトコル、もしくはAPI に変換し、レスポンスを処理し、データを返します。 これらのOData パラメータの詳細については、API Server ページのヘルプドキュメントに記載されています。

OData よりさらに使いやすいAPI Server Drivers

OData プロトコルでのデータ連携に対応していないツールに対しては、CData は標準SQL ベースでのデータ連携を実現するAPI Server 向けドライバー製品を提供します。 ADO.NET、ODBC、JDBC などの標準インターフェースのドライバーおよび、Excel、SSIS、BizTalk、PowerShell などの製品から直接API Server にアクセスすることが可能です。

API Server Drivers では、接続プロパティでAPI Server に接続を確立するだけです。 接続確立後は、他のドライバー製品と同じように、自動でスキーマ検出を行い、標準SQL でのCRUD 処理が可能です。

複雑なクエリの処理: JOINs & 集計

API Server は、SQL-92 規格のクエリを直接受けることができ、JOIN や集計などの複雑なクエリを処理することができます。 API Server は、可能な限り、データ処理をデータソース側で行うようにしています。この機能はAPI Server Drivers から使うことができます。 詳細については、API Server ページのヘルプドキュメントに記載されています。

生成したAPI の配布・公開

生成したAPI の配布には、エンドポイントのみのインスタンスを配布することができます。 API Server の［デプロイ］タブからこの処理を行います。デプロイ先プラットフォーム（Windows、Java、PHP、Node.js）、ロケーション、およびログを保存するデータベースを指定します。 ヘルプドキュメントを同じ場所にデプロイすることも可能です。 詳細については、API Server ページのヘルプドキュメントに記載されています。

何からはじめればよいですか？

API Server は、現在Windows、Mac、Linux/Unix 上で動作します。 API Server をダウンロードして、RDB やお好みのSaaS、NoSQL、フラットファイルからのREST API 生成を体感してください。 30日の無償試用版や、パーソナル利用の無償版があります。

API Server についても便利なナレッジベース記事を充実させていきます。 次のような、代表的なホスティング環境での利用記事を参照してください Microsoft Azure、 Amazon EC2、Heroku。