Klient DDB TypeScript/JavaScript

Pełna dokumentacja pakietu ddb-js TypeScript, który upraszcza dostęp do interfejsu API DDB za pomocą TypeScript.

Uwaga dla użytkowników zewnętrznych - Wiele linków w następnej sekcji patrz aplikacje wewnętrzne. Porozmawiaj ze swoim zespołem projektowym o wsparcie.

Wymagania wstępne

Będziesz potrzebować oprogramowania poniżej zainstalowanego w środowisku

• Węzeł JS v16.x
• NPM v8.x+

Zobacz, jak pobrać te pakiety Tutaj (opens new window)

Uwierzytelnienie w rejestrze Azure NPM

ddb-js Pakiety są hostowane w (prywatnym) rejestrze pakietu Azure NPM. Aby go zainstalować, musisz uwierzytelnić, patrz poniżej opcje poniżej.

Okna

Aby użyć pakietów NPM, uzyskaj NPM (który jest wyposażony w Node.js) i pomocnik vsts-npm-auth.

Krok 1

Zainstaluj warunki wstępne

Krok 2

Uruchom to polecenie

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

Krok 3

Dodaj .npmrc do swojego projektu, w tym samym katalogu co twój pakiet.json

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

Następnie uruchom VSTS-NPM-Auth, aby uzyskać token Azure Artefacts dodany do pliku .npmrc na poziomie użytkownika.

vsts-npm-auth -config .npmrc

Uwaga: nie musisz tego robić za każdym razem. NPM da ci nieautoryzowany błąd 401, gdy będziesz musiał go ponownie uruchomić. Masz problemy? Zobacz instrukcje dotyczące używania osobistego tokena dostępu do uwierzytelnienia .

Inni

Krok 1

Zainstaluj warunki wstępne

Krok 2

Dodaj .npmrc do swojego projektu, w tym samym katalogu co twój pakiet.json

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

Krok 3

Skopiuj poniższy kod do użytkownika .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

Krok 4

Wygeneruj Token osobisty (opens new window) z opakowaniami odczytu i zapisu.

Krok 5

Base64 koduje token osobisty dostępny z kroku 4.

Jedną bezpieczną i bezpieczną metodą base64 kodowania łańcucha jest:

Z przebiegu monitora poleceń/powłoki:

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

Wklej swoją osobistą wartość tokena dostępu i naciśnij Enter/Return Skopiuj wartość zakodowaną Base64

Krok 6

Wymień obie wartości BASE64_ENCODED_PERSONAL_ACCESS_TOKEN w pliku użytkownika .npmrc swoim tokenem osobistym od kroku 5.

Zastąp obie wartości [e -mail] w pliku użytkownika .npmrc e -mailem.

Instalacja

Po uwierzytelnianiu, jak opisano powyżej @ddb pakiety można zainstalować za pośrednictwem NPM. Wszystkie mikrousługi można instalować osobno

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

Przewodnik krok po kroku

Konfiguracja

Ten exmaple jest przeznaczony dla @ddb/komentarze

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)

Za pomocą interfejsu API

Wszystkie metody są inicjowane w klasie, a przykład tego, jak je nazywać

const comments = await commentsAPI.getComments()

Zapoznaj się z interfejsami TypeScript, aby zrozumieć parametry wymagane w żądaniu, a także odpowiedzi z tyłu z funkcji.

Uwaga: jeśli masz zainstalowany Intellisense, zostaniesz skierowany

Informacje o programistach

Znajduje się repozytorium Tutaj (opens new window) . Zobacz, jak brać w czymś udział (opens new window) .