# DDB TypeScript/JavaScript İstemcisi
TypeScript kullanarak DDB API'sına erişimi basitleştiren ddb-js TypeScript paketinin tam dokümantasyonu.
Harici kullanıcılar için not - Aşağıdaki bölümdeki bağlantıların çoğu dahili uygulamaları ifade eder. Lütfen destek için proje ekibinizle konuşun.
# Önkoşul
Aşağıdaki yazılıma ortamınıza yüklü ihtiyacınız olacak
Düğüm JS v16.x
NPM v8.x+
Bu paketleri nasıl indireceğinizi görün Burada (opens new window)
# Azure NPM Kayıt Defterinin Kimlik Doğrulanması
ddb-js Paketler (özel) Azure NPM paket kayıt defterinde barındırılır. Yüklemek için kimliği doğrulamanız gerekir, aşağıdaki seçeneklere bakın.
# pencereler
NPM paketlerini kullanmak için NPM (Node.js ile birlikte gelir) ve vsts-npm-auth yardımcısı alın.
Aşama 1
Adım 2
Bu komutu çalıştır
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Aşama 3
Paketinizle aynı dizinine projenize bir .npmrc ekleyin.
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Ardından, kullanıcı düzeyinde .npmrc dosyanıza eklenen bir Azure Artifacts jetonu almak için VSTS-NPM-AUTH çalıştırın.
vsts-npm-auth -config .npmrc
Not: Bunu her seferinde yapmanıza gerek yok. NPM, tekrar çalıştırmanız gerektiğinde size 401 yetkisiz bir hata verecektir.
Sorunlar mı yaşıyorsunuz? Kimlik Doğrulamak için Kişisel Erişim Seteni Kullanma Talimatlarına bakın .
# Diğerleri
Aşama 1
Adım 2
Paketinizle aynı dizinine projenize bir .npmrc ekleyin.
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Aşama 3
Aşağıdaki kodu kullanıcınıza .npmrc (~/.npmrc) 'e kopyalayın.
; 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
4. Adım
Bir Kişisel Erişim Jetonu (opens new window) Ambalaj ile okuma ve yazma kapsamları.
Adım 5
Base64 Kişisel erişim belirtecini 4. adımdan kodlayın.
Base64'ün bir dizeyi kodlamasının güvenli ve güvenli bir yöntemi şudur:
Bir komut/kabuk istemi çalışmasından:
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(); })"
Kişisel erişim belirteci değerinizi yapıştırın ve Enter/Return tuşuna basın
Base64 kodlu değerini kopyalayın
Adım 6
Kullanıcınızdaki BASE64_ENCODED_PERSONAL_ACCESS_TOKEN değerlerini .npmrc dosyanızda 5. adımdan kişisel erişim belirtecinizle değiştirin.
Kullanıcınızdaki [e -posta] değerlerini .npmrc dosyasını e -postanızla değiştirin.
# Kurulum
Yukarıda tarif edildiği gibi kimlik doğrulamasından sonra @ddb paketleri NPM aracılığıyla kurulabilir. Tüm mikro hizmetler ayrı ayrı kurulabilir
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`
# Adım adım rehber
# Konfigürasyon
Bu exmaple @ddb/yorum hizmetleri içindir
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)
# API kullanma
Tüm yöntemler sınıfta başlatılır ve bunları nasıl çağıracağı örneği aşağıdadır
const comments = await commentsAPI.getComments()
İstekte gerekli olan parametreleri ve ayrıca işlevden gelen yanıtları anlamak için TypeScript arabirimlerine bakın.
Not: IntelliSense yüklüyseniz, yönlendirileceksiniz
# Geliştirici bilgileri
Depo bulunur Burada (opens new window) . Nasıl yapılacağını gör katkı yapmak (opens new window) .