API Server 2020


API Server 2020


概要

CData API Server を使用すると、既存のエンタープライズデータからREST API を構築できます。簡単なポイント&クリックの設定で、データベース、ファイルストア、バックエンドAPI をWebアプリケーション、モバイルアプリケーション、およびカスタムアプリケーションに公開することができます。

主要機能

  • あらゆるデータベースのAPI:SQL、NoSQL、およびその他のデータソース(SQL Server、MySQL、DB2、Mongo、Cassandra、フラットファイルなど)用のAPI を生成。
  • オープンデータアクセス:OData、REST、JSON、SOAP、CSV/TSV などの一般的な形式のエントリポイントを公開。
  • API 管理:API の監視、ロギングおよびレート制限の有効化など。
  • 任意のプラットフォームへの公開:イントラネット、インターネットフェーシングサーバー、またはクラウド上でAPI Server をホスト。

はじめに

ステップバイステップの設定ガイドについては、はじめに を参照してください。

サーバー設定

CData API Server は、.NET 版およびJava 版で利用可能な、軽量Web アプリケーションです。

Windows(.NET)版のホスティング

Windows 版では、スタンドアロンサーバーがインストールされます:サーバーの起動 を参照してください。または、IIS でAPI Server をホストします:IIS での設定 を参照してください。

Java 版のホスティング

Java 版は、ドロップインインストールでWAR ファイルとしてパッケージ化されています。API Server をTomcat やその他の一般的なJava サーバー上でホストするには、Java 版 を参照してください。

ファイアウォールの背後でのホスティング

Windows 版のCloud Gateway 機能を使用すると、埋め込みのSSH リバーストンネリングを使ってファイアウォールを越えて内部リソースを安全に公開することができます。Cloud Gateway を使うと、ファイアウォールの外側のSSH ホストへのSSH リバーストンネルを構築できます。Gateway はリバーストンネル接続も管理できます。接続が失われたり中断された場合は、サードパーティーツールを必要とすることなく再接続します。

API デザイン

標準のREST API の使用を開始するには、API デザイン を参照してください。

  • アクセスの認証および制御:API ユーザーおよびauthtoken を作成するには、ユーザー を参照してください。HTTP 認証 でユーザーのauthtoken を指定することができます。authtoken は、ユーザーの権限セットを定義します。これは、サーバーのレート制限 のデフォルトをオーバーライドします。 API へのクライアントアクセスを有効にする手順については、API の設定 を参照してください。例えば、ブラウザベースのクライアントから接続するにはCORS を設定する必要があります。

  • API の検出:OpenAPI(Swagger)に基づいて、API は完全にドキュメント化され検出可能です。アプリやクライアントサイドライブラリなどにメタデータURL を提供するには、検出 を参照してください。

  • API のクエリ:OData、JSON、またはCData Drivers for API Server 経由で接続できます。さまざまな標準ベースツールからの接続については、API のクエリ を参照してください。

    OData およびJSON エンドポイントへのHTTP リクエストを作成するには、次のセクションを参照してください。リソース およびアクション では、CRUD 操作の実行方法について説明します。リソースのフィルタリング では、データの検索方法について説明します。追加フォーマット では、JSONP など他のWeb サービスの利用可能なエンドポイントからデータをリクエストする方法を説明します。

    サーバーレスポンス はHTTP 応答を列挙します。

  • API のデプロイ:API Server および異なるサーバーで個別に設計するAPI をホストするには、デプロイメント を参照してください。

ログと通知

ログ では、サーバーレベルとアプリケーションレベルで使用可能なロギングリソースについて詳しく説明します。

Advanced

API のリソースは、テキストベースのスキーマのオーサリングによって定義されます。これはシンプルな形式で編集が簡単です。スキーマを拡張するか、独自に記述して、データのRESTful ビューを制御します。カラムのデータ型の変更などの変更を行うには、典型的なカスタマイズ を参照してください。

またAdvanced は、ストアドプロシージャを使ってデータベースビューを更新するなど、より高度な統合を実現するためにスキーマを拡張するためのリファレンスを提供しています。スキーマのカスタマイズ では、スキーマの一部を紹介します。