# DDB Typecript/JavaScript -Client
Vollständige Dokumentation des ddb-js TypeScript -Pakets, das den Zugriff auf die DDB -API mithilfe von TypeScript vereinfacht.
Hinweis für externe Benutzer - Viele der Links im folgenden Abschnitt beziehen sich auf interne Anwendungen. Bitte sprechen Sie mit Ihrem Projektteam zur Unterstützung.
# Voraussetzungen
Sie benötigen die folgende Software in Ihrer Umgebung
- Knoten JS v16.x
- NPM v8.x+
Sehen Sie, wie Sie diese Pakete herunterladen Hier (opens new window)
# Authentifizieren sich mit dem Azure NPM -Register
ddb-js Pakete werden in der (privaten) Azure NPM -Paketregistrierung gehostet. Um es zu installieren, müssen Sie sich authentifizieren, siehe unten die folgenden Optionen.
# Fenster
Um NPM -Pakete zu verwenden, erhalten Sie NPM (was mit Node.js ausgestattet ist) und den vsts-npm-auth Helfer.
Schritt 1
Installieren Sie die Voraussetzungen
Schritt 2
Führen Sie diesen Befehl aus
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Schritt 3
Fügen Sie Ihrem Projekt in demselben Verzeichnis wie Ihr Paket.json einen .npmrc hinzu
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Führen Sie dann VSTS-NPM-AUTH aus, um ein Azure-Artefakt-Token zu Ihrer .npmrc-Datei auf Benutzerebene hinzuzufügen.
vsts-npm-auth -config .npmrc
Hinweis: Sie müssen dies nicht jedes Mal tun. NPM gibt Ihnen einen 401 nicht autorisierten Fehler, wenn Sie ihn erneut ausführen müssen. Probleme haben? Sehen Sie sich die Anweisungen zur Authentifizierung anhand eines persönlichen Zugriffs -Tokens an .
# Andere
Schritt 1
Installieren Sie die Voraussetzungen
Schritt 2
Fügen Sie Ihrem Projekt in demselben Verzeichnis wie Ihr Paket.json einen .npmrc hinzu
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Schritt 3
Kopieren Sie den folgenden Code an Ihren Benutzer .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
Schritt 4
Erzeugen a Personal Access Token (opens new window) Mit Verpackung Lesen & Schreiben Scopes.
Schritt 5
Base64 Encodieren Sie das persönliche Zugriffs -Token aus Schritt 4.
Eine sichere und sichere Methode von Base64, die eine Zeichenfolge codiert, ist:
Aus einem Befehl/Shell -Eingabeauflauflauf:
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(); })"
Fügen Sie Ihren persönlichen Zugriffs -Token -Wert ein und drücken Sie die Eingabetaste/Rückgabe Kopieren Sie den base64 codierten Wert
Schritt 6
Ersetzen Sie beide BASE64_ENCODED_PERSONAL_ACCESS_TOKEN -Werte in Ihrem Benutzer .NPMRC -Datei durch Schritt 5 durch Ihren persönlichen Zugriffs -Token.
Ersetzen Sie beide [E -Mail] -Werte in Ihrem Benutzer .NPMRC -Datei durch Ihre E -Mail.
# Installation
Nach der Authentifizierung wie oben beschrieben können @ddb Pakete über NPM installiert werden. Alle Microservices können separat installiert werden
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
# Schritt für Schritt Anleitung
# Aufbau
Dieser Exmaple ist für @DDB/Kommentare-Service ist
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)
# Verwenden der API
Alle Methoden werden in der Klasse eingeleitet, und Beispiele dafür, wie sie aufgerufen werden können
const comments = await commentsAPI.getComments()
Siehe die Typscript -Schnittstellen, um die in der Anforderung erforderlichen Parameter und auch die Antworten aus der Funktion zu verstehen.
Hinweis: Wenn Sie IntelliSense installiert haben, werden Sie angewiesen
# Entwicklerinformationen
Das Repository befindet sich Hier (opens new window) . Sehen Sie, wie man beitragen (opens new window) .