利用開始

HERE Data SDK for TypeScript には、任意の Web ベースのアプリケーションから HERE API にアクセスするためのコアコンポーネントが含まれています。

このガイドでは、 Data SDK を使用して HERE platform で認証を行い、作業を開始する方法について説明します。

前提条件

Data SDK for TypeScript の使用を開始するには、プラットフォームユーザーアカウントが必要です。

Data SDK で作業するには、次の項目についての知識が必要です。

概念

Data SDK for TypeScript を使用するには、 HERE platform に関連する次の概念を理解しておく必要があります。

詳細については 、 Data ユーザー ガイドを参照してください。

資格情報を入手します

HERE platform に対するカタログまたはサービスリクエストを処理するには、認証と承認の資格情報を取得する必要があります。

プラットフォーム資格情報で利用可能な HERE ポータルを使用して、アプリケーション内の HERE platform に対する認証を行うことができます。認証には、 Data SDK 認証ライブラリが使用されます。 使用可能な認証オプションについては、『 Identity & Access Management 開発者ガイド』を参照してください。

資格情報を設定した後で、それらを使用して Data SDK ライブラリにアクセスできます。

インストール

NPM を使用して Data SDK モジュールをインストールするか、またはコンパイル済みのバンドルを HTML ページに追加できます。

NPM を使用して Data SDK モジュールをインストールするには、次のコマンドを実行します。

npm install @here/olp-sdk-authentication
npm install @here/olp-sdk-core
npm install @here/olp-sdk-dataservice-read
npm install @here/olp-sdk-dataservice-write
npm install @here/olp-sdk-dataservice-api

純粋な JavaScript で Data SDK を使用するには、 HTML アプリケーションの CDN レポジトリからコンパイル済みのバンドルを挿入します。

<script src="https://unpkg.com/@here/olp-sdk-fetch/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-core/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-authentication/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-dataservice-api/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-dataservice-read/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-dataservice-write/bundle.umd.min.js"></script>

Data SDK の使用方法については 、『開発者ガイド and API リファレンス』を参照してください。

開発

依存関係

Data SDK for TypeScript には、次の依存関係があります。

注 : NPM の代わり に、ヤーン 2+ を使用することもできます ( 取り付け手順については、ヤーンを参照してください ) 。

依存関係をダウンロードします

現在の Lerna リポジトリ内のパッケージをブートストラップし、すべての相互依存パッケージをインストールし、相互依存関係をリンクするには、次のコマンドを実行します。

yarn install && yarn bootstrap

SDK を構築します

TypeScript ソースコードを JavaScript コードにビルドするには、次のコマンドを実行します。

npm run build

SDK をテストします

単体テストおよび統合テストを使用して、ビルドの結果をテストできます。

単体テストを使用してビルドの結果をテストするには、次のコマンドを実行します。

npm run test

統合テストを使用してビルドの結果をテストするには、次のコマンドを実行します。

npm run integration-test

カバレッジをテストします

単体テストを実行し、テストカバレッジレポートを生成するには、次のコマンドを実行します。

npm run coverage

TypeDoc を使用してドキュメントを生成します

すべてのモジュールおよびクラスのドキュメントを生成するには、次のコマンドを実行します。

npm run typedoc

dist/doc フォルダは、注釈付きのソースコードのドキュメントで生成されます。

バンドル機能を使用します

コンパイル済みのプロジェクトを作成する場合は、バンドルコマンドを使用できます。 次の各コマンドを実行すると、各パッケージのルートフォルダーから .js バンドルファイルが取得されます。

@here/olp-sdk-authentication/bundle.umd.min.js
@here/olp-sdk-core/bundle.umd.min.js
@here/olp-sdk-dataservice-read/bundle.umd.min.js
@here/olp-sdk-dataservice-write/bundle.umd.min.js
@here/olp-sdk-dataservice-api/bundle.umd.min.js
@here/olp-sdk-fetch/bundle.umd.min.js

すべてのモジュールのソースマップファイルにバンドルされている .js ファイルを取得するには、次のコマンドを実行します。

npm run bundle:dev

プロダクション用に縮小されたバージョンを取得するには、次のコマンドを実行します。

npm run bundle:prod

バンドルされ、縮小された .js ファイルを取得するには、次のコマンドを実行します。

npm run bundle

利用可能なコンポーネント

Data SDK パッケージには、特定の責任範囲に焦点を当てた複数の独立したモジュールが含まれています。

  • olp-sdk-authentication –プラットフォームリクエストの確認に使用される OAuth2 ベアラトークンを取得します。
  • olp-sdk-core – @here/olp-sdk-dataservice-read、 @here/olp-sdk-dataservice-api、およびに共通のコードが含ま @here/olp-sdk-authenticationれています。
  • olp-sdk-dataservice-read –プラットフォームカタログからレイヤーおよびパーティション データを取得します。
  • olp-sdk-dataservice-write –レイヤーにデータを書き込みます。
  • olp-sdk-dataservice-api – HERE platform からデータを取得します。
  • olp-sdk-fetch – Node.js の FETCH API のサブセットを追加します。

参照ドキュメント

Data SDK の API リファレンス ドキュメントは 、 GitHub のページから入手できます。

例

HERE Data SDK for TypeScript の詳細については 、「例」セクションを参照してください。

「」に一致する結果は 件です

    「」に一致する結果はありません