DDB TypeScript/JavaScript -client

Volledige documentatie van het ddb-js TypeScript -pakket, dat de toegang tot de DDB API vereenvoudigt met behulp van TypeScript.

Opmerking voor externe gebruikers - Veel van de links in de volgende sectie verwijzen naar interne toepassingen. Praat alstublieft met uw projectteam voor ondersteuning.

Voorwaarden

U hebt de onderstaande software nodig die op uw omgeving is geïnstalleerd

• Node JS v16.x
• npm v8.x+

Zie hoe u deze pakketten kunt downloaden hier (opens new window)

Verifiëren van het Azure NPM -register

ddb-js pakketten worden gehost op het (privé) Azure NPM -pakketregister. Om het te installeren, moet u authenticeren, zie hieronder opties hieronder.

ramen

Om NPM -pakketten te gebruiken, krijgt u NPM (die wordt geleverd met Node.js) en de vsts-npm-auth helper.

Stap 1

Installeer de vereisten

Stap 2

Voer deze opdracht uit

npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false

Stap 3

Voeg een .npmrc toe aan uw project, in dezelfde map als uw pakket.json

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true

Voer vervolgens VSTS-NPM-AUTH uit om een Azure Artifacts-token te krijgen toegevoegd aan uw gebruikersniveau .NPMRC-bestand.

vsts-npm-auth -config .npmrc

Opmerking: u hoeft dit niet elke keer te doen. NPM geeft u een 401 ongeautoriseerde fout wanneer u deze opnieuw moet uitvoeren. Problemen hebben? Zie de instructies voor het gebruik van een persoonlijke toegangstoken om te authenticeren .

Anderen

Stap 1

Installeer de vereisten

Stap 2

Voeg een .npmrc toe aan uw project, in dezelfde map als uw pakket.json

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true

Stap 3

Kopieer de onderstaande code naar uw gebruiker .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

Stap 4

Genereer een Persoonlijke toegang token (opens new window) met verpakking Read & Write Scopes.

Stap 5

BASE64 CODECTEER DE PERSOONLIJKE TOEGANG TOKEN vanaf stap 4.

Een veilige en veilige methode van base64 die een string coderen, is:

Van een opdracht/shell -prompt run:

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(); })"

Plak uw persoonlijke toegang tokenwaarde en druk op ENTER/RETOUR Kopieer de Base64 -gecodeerde waarde

Stap 6

Vervang beide BASE64_ENCODED_PERSONAL_ACCESS_TOKENwaarden in uw gebruiker .npmrc -bestand door uw persoonlijke toegang token vanaf stap 5.

Vervang beide [e -mail] waarden in uw gebruiker .npmrc -bestand door uw e -mail.

Installatie

Na authenticeren zoals hierboven beschreven, kunnen @ddb -pakketten worden geïnstalleerd via NPM. Alle microservices kunnen afzonderlijk worden geïnstalleerd

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

Stap voor stap gids

Configuratie

Deze uitzondering is voor @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)

De API gebruiken

Alle methoden worden op de klasse geïnitieerd, en voorbeeld van hoe ze ze moeten bellen, zijn hieronder

const comments = await commentsAPI.getComments()

Raadpleeg de Typescript -interfaces om de parameters te begrijpen, vereist in het verzoek, en ook de antwoorden terug van de functie.

Opmerking: als u Intellisense hebt geïnstalleerd, wordt u gericht

Ontwikkelaarsinformatie

De repository is gelokaliseerd hier (opens new window) . Zie hoe bijdragen (opens new window) .