# DDB TypeScript/JavaScript Client
Fuld dokumentation af ddb-js TypeScript -pakken, som forenkler adgangen til DDB API ved hjælp af TypeScript.
Bemærk til eksterne brugere - Mange af linkene i det følgende afsnit henviser til interne applikationer. Tal venligst til dit projektteam for support.
# Forudsætninger
Du har brug for softwaren nedenfor installeret på dit miljø
- Node JS V16.X
- NPM V8.x+
Se hvordan man downloader disse pakker her (opens new window)
# Autentificer til Azure NPM -registreringsdatabasen
ddb-js Pakker er vært på det (private) Azure NPM -pakkeregister. For at installere det skal du autentificere, se nedenstående indstillinger nedenfor.
# Windows
For at bruge NPM -pakker skal du få NPM (som leveres med Node.js) og vsts-npm-auth hjælper.
Trin 1
Trin 2
Kør denne kommando
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Trin 3
Tilføj en .npmrc til dit projekt i det samme bibliotek som din pakke.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Kør derefter VSTS-NPM-autor for at få en Azure-artefakter-token tilføjet til din brugerniveau .npmrc-fil.
vsts-npm-auth -config .npmrc
Bemærk: Du behøver ikke at gøre dette hver gang. NPM giver dig en 401 uautoriseret fejl, når du har brug for at køre den igen. Har du problemer? Se instruktionerne til brug af et personligt adgangstoken til at autentificere .
# Andre
Trin 1
Trin 2
Tilføj en .npmrc til dit projekt i det samme bibliotek som din pakke.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Trin 3
Kopier koden nedenfor til din bruger .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
Trin 4
Generere en Personlig adgangstoken (opens new window) Med emballage læst og skriv scopes.
Trin 5
BASE64 koder for det personlige adgangstoken fra trin 4.
En sikker og sikker metode til base64, der koder for en streng, er at:
Fra en kommando/shell -prompt kørsel:
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(); })"
Indsæt din personlige adgangstokenværdi og tryk på Enter/Return Kopier base64 -kodet værdi
Trin 6
Udskift begge BASE64_ENCODED_PERSONAL_ACCESS_TOKEN -værdier i din bruger .npmrc -fil med dit personlige adgangstoken fra trin 5.
Udskift begge [e -mail] -værdier i din bruger .npmrc -fil med din e -mail.
# Installation
Efter autentificering som beskrevet ovenfor @ddb pakker kan installeres via NPM. Alle mikroservices kan installeres separat
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
# Trin for trin guide
# Konfiguration
Denne exmaple er til @ddb/kommentar-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)
# Ved hjælp af API
Alle metoder initieres på klassen, og eksempel på, hvordan man kalder dem, er nedenfor
const comments = await commentsAPI.getComments()
Se TypeScript -grænsefladerne for at forstå parametrene, der kræves i anmodningen, og også svarene tilbage fra funktionen.
BEMÆRK: Hvis du har Intellisense installeret, vil du blive instrueret
# Udviklerinformation
Repositoriet er placeret her (opens new window) . Se hvordan bidrage (opens new window) .