# عميل DDB TypeScript/JavaScript
الوثائق الكاملة لحزمة ddb-js typescript ، والتي تبسط الوصول إلى واجهة برمجة تطبيقات DDB باستخدام TypeScript.
ملاحظة للمستخدمين الخارجيين - تشير العديد من الروابط في القسم التالي إلى التطبيقات الداخلية. يرجى التحدث إلى فريق المشروع الخاص بك للحصول على الدعم.
# المتطلبات الأساسية
ستحتاج إلى البرنامج أدناه المثبت على بيئتك
- عقدة JS V16.x
- NPM V8.x+
انظر كيفية تنزيل هذه الحزم هنا (opens new window)
# المصادقة على سجل Azure NPM
ddb-js يتم استضافة الحزم في سجل حزمة Azure NPM (الخاص). من أجل تثبيته ، يجب المصادقة ، انظر الخيارات أدناه أدناه.
# شبابيك
لاستخدام حزم NPM ، احصل على NPM (الذي يأتي مع Node.js) و vsts-npm-auth المساعد.
الخطوة 1
الخطوة 2
تشغيل هذا الأمر
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
الخطوه 3
أضف .npmrc إلى مشروعك ، في نفس الدليل مثل package.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
بعد ذلك ، قم بتشغيل VSTS-NPM-Auth للحصول على رمز Azure Artifacts تمت إضافته إلى ملف .npmrc على مستوى المستخدم.
vsts-npm-auth -config .npmrc
ملاحظة: لا تحتاج إلى القيام بذلك في كل مرة. سوف تعطيك NPM خطأ 401 غير مصرح به عندما تحتاج إلى تشغيله مرة أخرى. وجود مشاكل؟ راجع إرشادات استخدام رمز الوصول الشخصي للمصادقة .
# آحرون
الخطوة 1
الخطوة 2
أضف .npmrc إلى مشروعك ، في نفس الدليل مثل package.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
الخطوه 3
انسخ الرمز أدناه إلى المستخدم .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
الخطوة 4
توليد أ رمز الوصول الشخصي (opens new window) مع عبوة قراءة وكتابة النطاقات.
الخطوة 5
BASE64 تشفير رمز الوصول الشخصي من الخطوة 4.
طريقة واحدة آمنة ومأمونة لترميز السلسلة هي:
من تشغيل موجه أمر/قذيفة:
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(); })"
الصق قيمة الرمز المميز للوصول الشخصي واضغط على الإدخال/الإرجاع انسخ القيمة المشفرة BASE64
الخطوة 6
استبدل كلا القيمين BASE64_ENCODED_PERSONAL_ACCESS_TOKEN في ملف .npmrc من المستخدم الخاص بك برمز الوصول الشخصي الخاص بك من الخطوة 5.
استبدل كل من قيمنا [البريد الإلكتروني] في ملف .npmrc الخاص بك باستخدام بريدك الإلكتروني.
# تثبيت
بعد المصادقة كما هو موضح أعلاه ، يمكن تثبيت حزم @ddb عبر NPM. يمكن تثبيت جميع الخدمات المجهرية بشكل منفصل
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
# دليل خطوة بخطوة
# إعدادات
هذا exmaple مخصص لـ @ddb/التعليقات
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
يتم بدء جميع الطرق في الفصل ، ومثال على كيفية الاتصال بها أدناه
const comments = await commentsAPI.getComments()
ارجع إلى واجهات TypeScript لفهم المعلمات ، المطلوبة في الطلب ، وكذلك الاستجابات مرة أخرى من الوظيفة.
ملاحظة: إذا كنت قد قمت بتثبيت Intellisense ، فسيتم توجيهك
# معلومات المطور
يقع المستودع هنا (opens new window) . انظر كيف يساهم (opens new window) .