# DDB TypeScript/JavaScript Client
Documentación completa del paquete ddb-js TypeScript, que simplifica el acceso a la API DDB usando TypeScript.
Nota para usuarios externos - Muchos de los enlaces en la siguiente sección se refieren a aplicaciones internas. Hable con su equipo de proyecto para obtener apoyo.
# Requisitos previos
Necesitará el software a continuación instalado en su entorno
- Nodo js v16.x
- NPM V8.X+
Vea cómo descargar estos paquetes aquí (opens new window)
# Autenticar en el registro de Azure NPM
ddb-js Los paquetes están alojados en el registro (privado) del paquete Azure NPM. Para instalarlo, debe autenticarlo, consulte las opciones a continuación a continuación.
# Windows
Para usar paquetes NPM, obtenga NPM (que viene con Node.js) y el ayudante vsts-npm-auth.
Paso 1
Instale los requisitos previos
Paso 2
Ejecute este comando
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Paso 3
Agregue un .NPMRC a su proyecto, en el mismo directorio que su paquete.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Luego, ejecute VSTS-NPM-Auth para obtener un token de artefactos Azure agregado a su archivo .NPMRC a nivel de usuario.
vsts-npm-auth -config .npmrc
Nota: No necesita hacer esto cada vez. NPM le dará un error 401 no autorizado cuando necesite ejecutarlo nuevamente. ¿Teniendo problemas? Consulte las instrucciones para usar un token de acceso personal para autenticar .
# Otras Otros
Paso 1
Instale los requisitos previos
Paso 2
Agregue un .NPMRC a su proyecto, en el mismo directorio que su paquete.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Paso 3
Copie el código a continuación a su usuario .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
Etapa 4
Generar un Token de acceso personal (opens new window) con paquetes de lectura y escritura de ámbitos.
Paso 5
Base64 Codifique el token de acceso personal desde el paso 4.
Un método seguro y seguro de codificación de una cadena es:
Desde un comando/solicitado de shell Ejecutar:
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(); })"
Pegue su valor del token de acceso personal y presione Entrar/Return Copiar el valor codificado Base64
Paso 6
Reemplace ambos valores de BASE64_ENCODED_PERSONAL_ACCESS_TOKEN en su archivo .NPMRC de usuario con su token de acceso personal desde el paso 5.
Reemplace ambos valores [correo electrónico] en su archivo .NPMRC de usuario con su correo electrónico.
# Instalación
Después de autenticar como se describe anteriormente, los paquetes @ddb se pueden instalar a través de NPM. Todos los microservicios se pueden instalar por separado
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
# Guía paso por paso
# Configuración
Este Exmaple es para @DDB/Comentarios-servicio
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)
# Usando la API
Todos los métodos se inician en la clase, y el ejemplo de cómo llamarlos están a continuación
const comments = await commentsAPI.getComments()
Consulte las interfaces TypeScript para comprender los parámetros, requeridos en la solicitud, y también las respuestas de la función.
NOTA: Si tiene instalado Intellisense, será dirigido
# Información del desarrollador
El repositorio se encuentra aquí (opens new window) . Ver como contribuir (opens new window) .