# Client DDB TypeScript/JavaScript
Documentazione completa del pacchetto TypeScript ddb-js, che semplifica l'accesso all'API DDB utilizzando TypeScript.
Nota per gli utenti esterni - Molti dei collegamenti nella sezione seguente si riferiscono alle applicazioni interne. Si prega di parlare con il tuo team di progetto per il supporto.
# Prerequisiti
Avrai bisogno del software di seguito installato sul tuo ambiente
- Nodo js v16.x
- NPM v8.x+
Guarda come scaricare questi pacchetti Qui (opens new window)
# Autenticarsi nel registro NPM di Azure
ddb-js I pacchetti sono ospitati sul registro dei pacchetti (privati) di Azure NPM. Per installarlo è necessario autenticare, vedere le opzioni seguenti di seguito.
# finestre
Per utilizzare i pacchetti NPM, ottieni NPM (che viene fornito con node.js) e vsts-npm-auth helper.
Passo 1
Passo 2
Esegui questo comando
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Passaggio 3
Aggiungi un .npmrc al tuo progetto, nella stessa directory del pacchetto.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Quindi, esegui VSTS-NPM-Auth per ottenere un token di artefatti Azure aggiunto al tuo file .NPMRC a livello di utente.
vsts-npm-auth -config .npmrc
Nota: non è necessario farlo ogni volta. NPM ti darà un errore 401 non autorizzato quando è necessario eseguirlo di nuovo. Avere problemi? Vedere le istruzioni per l'utilizzo di un token di accesso personale per autenticare .
# Altre Altri
Passo 1
Passo 2
Aggiungi un .npmrc al tuo progetto, nella stessa directory del pacchetto.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Passaggio 3
Copia il codice seguente nell'utente .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
Passaggio 4
Generare a Token di accesso personale (opens new window) Con imballaggi Leggi e scrivi ambiti.
Passaggio 5
Base64 codifica il token di accesso personale dal passaggio 4.
Un metodo sicuro e sicuro di base64 che codifica una stringa è:
Da un prompt di comando/shell Esegui:
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(); })"
Incolla il valore del token di accesso personale e premere Invio/Return Copia il valore codificato Base64
Passaggio 6
Sostituisci entrambi i valori BASE64_ENCODED_PERSONAL_ACCESS_TOKEN nel file .npmrc dell'utente con il tuo token di accesso personale dal passaggio 5.
Sostituisci entrambi i valori [e -mail] nel file .npmrc dell'utente con la tua e -mail.
# Installazione
Dopo l'autenticazione come descritto sopra @ddb i pacchetti possono essere installati tramite NPM. Tutti i microservizi possono essere installati separatamente
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
# Guida passo per passo
# Configurazione
Questo exmaple è per @ddb/commenti-servizio
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)
# Usando l'API
Tutti i metodi sono iniziati sulla classe e l'esempio di come chiamarli sono di seguito
const comments = await commentsAPI.getComments()
Fare riferimento alle interfacce TypeScript per comprendere i parametri, richiesti nella richiesta e anche le risposte dalla funzione.
Nota: se hai installato Intellisense, verrai diretto
# Informazioni sugli sviluppatori
Il repository si trova Qui (opens new window) . Guarda come contribuire (opens new window) .