# DDB TypeScript/JavaScript クライアント
TypeScript を使用して DDB API へのアクセスを簡素化するddb-jsタイプスクリプトパッケージの完全なドキュメント。
外部ユーザーにはメモ - 次のセクションのリンクの多くは、内部アプリケーションを参照してください。 サポートについては、プロジェクトチームに相談してください。
# 前提条件
以下のソフトウェアが環境にインストールされている必要があります
- ノード JS v16.x
- NPM V8.x+
これらのパッケージをダウンロードする方法をご覧ください ここ (opens new window)
# Azure NPM レジストリに認証します
ddb-jsパッケージは、（プライベート）Azure NPM パッケージレジストリでホストされています。 インストールするには、認証する必要があります。以下のオプションを参照してください。
# ウィンドウズ
NPM パッケージを使用するには、NPM（node.js が付属）とvsts-npm-authヘルパーを取得します。
ステップ 1
ステップ 2
このコマンドを実行します
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
ステップ 3
Package.json と同じディレクトリで、プロジェクトに.npmrc を追加します。
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
次に、VSTS-NPM-Auth を実行して、ユーザーレベルの.NPMRC ファイルに追加された Azure Artifacts トークンを取得します。
vsts-npm-auth -config .npmrc
注：毎回これを行う必要はありません。 NPM は、再度実行する必要がある場合、401 の不正エラーを提供します。 問題がありますか？ 個人的なアクセストークンを使用して認証する手順を参照してください 。
# その他
ステップ 1
ステップ 2
Package.json と同じディレクトリで、プロジェクトに.npmrc を追加します。
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
ステップ 3
以下のコードをユーザー.npmrc（〜/.npmrc）にコピーします。
; begin auth token
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/:username=ovearup
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/:email=[EMAIL]
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/:username=ovearup
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/:email=[EMAIL]
; end auth token
ステップ 4
a を生成します 個人的なアクセストークン (opens new window) パッケージングの読み取りと書き込みスコープ。
ステップ 5
Base64 は、ステップ 4 からの個人アクセストークンをエンコードします。
文字列をエンコードする Base64 の安全で安全な方法の 1 つは、次のことです。
コマンド/シェルプロンプトの実行から：
node -e "require('readline') .createInterface({input:process.stdin,output:process.stdout,historySize:0}) .question('PAT> ',p => { b64=Buffer.from(p.trim()).toString('base64');console.log(b64);process.exit(); })"
あなたの個人的なアクセストークン値を貼り付けて、Enter/Return を押します base64 エンコードされた値をコピーします
ステップ 6
ユーザー.NPMRC ファイルの両方のBASE64_ENCODED_PERSONAL_ACCESS_TOKEN値を、ステップ 5 の個人アクセストークンに置き換えます。
ユーザー.NPMRC ファイルの両方の[電子メール]値をメールで置き換えます。
# インストール
上記のように認証後、@ddbパッケージは npm 経由でインストールできます。 すべてのマイクロサービスは個別にインストールできます
npm install @ddb/comments-service
npm install @ddb/environment-context-service
npm install @ddb/parameter-metadata-service
npm install @ddb/parameter-service
npm install @ddb/qa-service
npm install @ddb/reference-data-service
npm install @ddb/user-service
# ステップバイステップガイド
# 構成
この exmaple は @ddb/comments-service 用です
import { CommentsApi, Configuration, Environment } from "@ddb/comments-service";
// created a new configuration class
const config = new Configuration()
// specify the required environment, the default is production if the basepath isnt set
config.basePath = Environment.sandbox
// pass in the access token, note only pass in the accessToken, it will prefix with 'Bearer'
config.accessToken = 'token'
// Initialise the new class, with the config
const commentsAPI = new CommentsApi(config)
# API を使用します
すべての方法はクラスで開始され、それらを呼び出す方法の例は以下にあります
const comments = await commentsAPI.getComments()
タイプスクリプトインターフェイスを参照して、リクエストで必要なパラメーターと関数からの応答を理解してください。
注：IntelliSense がインストールされている場合は、指示されます
# 開発者情報
リポジトリはあります ここ (opens new window) 。 方法をご覧ください 助ける (opens new window) 。