# DDB TypeScript/JavaScript Client
Полная документация пакета TypeScript ddb-js, который упрощает доступ к API DDB с использованием TypeScript.
Примечание для внешних пользователей - Многие из ссылок в следующем разделе относятся к внутренним приложениям. Пожалуйста, поговорите с командой проекта для поддержки.
# Предварительные условия
Вам понадобится программное обеспечение, установленное в вашей среде
Узел 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 в ваш проект, в тот же каталог, что и ваш пакет.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Затем запустите VSTS-NPM-AUTH, чтобы получить токен Azure Artifacts, добавленный в ваш файл .NPMRC на уровне пользователя.
vsts-npm-auth -config .npmrc
Примечание: вам не нужно делать это каждый раз. NPM даст вам 401 несанкционированную ошибку, когда вам нужно запустить ее снова.
Есть проблемы? См. Инструкции по использованию токена личного доступа для аутентификации Полем
# Другие
Шаг 1
Шаг 2
Добавьте .npmrc в ваш проект, в тот же каталог, что и ваш пакет.json
@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
Генерировать а Личный токен доступа (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/return
Скопировать кодированное значение BASE64
Шаг 6
Замените оба значения BASE64_ENCODED_PERSONAL_ACCESS_TOKEN в вашем пользовательском файле .NPMRC вашим токеном личного доступа с шага 5.
Замените оба значения [Email] в вашем пользовательском файле .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()
Обратитесь к интерфейсам TypeScript, чтобы понять параметры, требуемые в запросе, а также ответы обратно из функции.
Примечание: если у вас установлен Intellisense, вы будете направлены
# Информация о разработчике
Репозиторий расположен здесь (opens new window) Полем Посмотрите, как способствовать (opens new window) Полем