DDB 打字条/JavaScript 客户端

ddb-js打字条软件包的完整文档，该包装简化了使用 Typescript 对 DDB API 的访问。

注意外部用户 - 以下部分中的许多链接涉及内部应用程序。 请与您的项目团队联系以寻求支持。

先决条件

您需要在环境上安装的以下软件

• 节点 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

在您的项目中添加.NPMRC，以与您的软件包相同的目录。

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/

always-auth=true

然后，运行 vsts-npm-auth 以获取添加到您的用户级别.NPMRC 文件中的 Azure 伪像令牌。

vsts-npm-auth -config .npmrc

注意：您不需要每次都这样做。 当您需要再次运行时，NPM 将为您提供 401 个未经授权的错误。

有问题？ 查看使用个人访问令牌进行身份验证的说明 。

其他的

步骤 1

安装先决条件

第 2 步

在您的项目中添加.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 的安全和安全方法是：

从命令/外壳提示运行：

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/返回

复制 base64 编码值

步骤 6

从步骤 5 开始，用您的个人访问令牌替换您的用户.NPMRC 文件中的两个BASE64_ENCODED_PERSONAL_ACCESS_TOKEN值。

用您的电子邮件中的用户.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/评论服务

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) 。