Cleient DDB TypeScript/JavaScript

Dogfennaeth lawn o'r pecyn ddb-js TypeScript, sy'n symleiddio mynediad i'r API DDB gan ddefnyddio TypeScript.

Nodyn ar gyfer defnyddwyr allanol - Mae llawer o'r dolenni yn yr adran ganlynol yn cyfeirio at gymwysiadau mewnol. Siaradwch â'ch tîm prosiect i gael cefnogaeth.

Rhagofynion

Bydd angen y feddalwedd isod ar eich amgylchedd arnoch chi

• Nod js v16.x
• npm v8.x+

Gweld sut i lawrlwytho'r pecynnau hyn yma (opens new window)

Dilysu i Gofrestrfa Azure NPM

Mae pecynnau ddb-js yn cael eu cynnal ar y Gofrestrfa Pecyn NPM Azure (preifat). Er mwyn ei osod mae'n rhaid i chi ddilysu, gweler yr opsiynau isod isod.

Ffenestri

I ddefnyddio pecynnau NPM, mynnwch NPM (sy'n dod gyda node.js) a'r cynorthwyydd vsts-npm-auth.

Cam 1

Gosodwch y rhagofynion

Cam 2

Rhedeg y gorchymyn hwn

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

Cam 3

Ychwanegwch .npmrc i'ch prosiect, yn yr un cyfeiriadur â'ch pecyn.json

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/

always-auth=true

Yna, rhedeg VSTS-NPM-Auth i gael tocyn Azure Arteffactau wedi'i ychwanegu at eich ffeil .NPMRC ar lefel defnyddiwr.

vsts-npm-auth -config .npmrc

Nodyn: Nid oes angen i chi wneud hyn bob tro. Bydd NPM yn rhoi gwall anawdurdodedig 401 i chi pan fydd angen i chi ei redeg eto. Cael problemau? Gweler y cyfarwyddiadau ar gyfer defnyddio tocyn mynediad personol i'w ddilysu .

Eraill

Cam 1

Gosodwch y rhagofynion

Cam 2

Ychwanegwch .npmrc i'ch prosiect, yn yr un cyfeiriadur â'ch pecyn.json

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/

always-auth=true

Cam 3

Copïwch y cod isod i'ch defnyddiwr .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

Cam 4

Cynhyrchu a Tocyn mynediad personol (opens new window) gyda phecynnu yn darllen ac ysgrifennu sgopiau.

Cam 5

Mae Base64 yn amgodio'r tocyn mynediad personol o gam 4.

Un dull diogel a diogel o Base64 sy'n amgodio llinyn yw:

O rediad prydlon gorchymyn/cragen:

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

Gludwch eich gwerth tocyn mynediad personol a gwasgwch ENTER/DYCHWELYD Copïwch y gwerth wedi'i amgodio base64

Cam 6

Amnewid y ddau werth BASE64_ENCODED_PERSONAL_ACCESS_TOKEN yn eich ffeil defnyddiwr .npmrc gyda'ch tocyn mynediad personol o gam 5.

Amnewid y ddau werth [e -bost] yn eich ffeil defnyddiwr .npmrc gyda'ch e -bost.

Gosodiadau

Ar ôl dilysu fel y disgrifir uchod gellir gosod pecynnau @ddb trwy NPM. Gellir gosod yr holl ficroservices ar wahân

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

Canllaw Cam wrth Gam

Chyfluniadau

Mae'r exmaple hwn ar gyfer @ddb/sylwadau-gwasanaeth

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)

Defnyddio'r API

Mae'r holl ddulliau'n cael eu cychwyn ar y dosbarth, ac mae enghraifft o sut i'w galw isod

const comments = await commentsAPI.getComments()

Cyfeiriwch at y rhyngwynebau teipysgrif i ddeall y paramedrau, sy'n ofynnol yn y cais, a hefyd yr ymatebion yn ôl o'r swyddogaeth.

SYLWCH: Os ydych chi wedi gosod Intellisense, byddwch chi'n cael eich cyfeirio

Gwybodaeth Datblygwr

Mae'r ystorfa wedi'i lleoli yma (opens new window) . Gweld sut i gyfrannom (opens new window) .