# ไคลเอนต์ DDB typescript/JavaScript
เอกสารเต็มรูปแบบของแพ็คเกจ typescript ddb-js ซึ่งช่วยให้การเข้าถึง DDB API ง่ายขึ้นโดยใช้ typeScript
หมายเหตุสำหรับผู้ใช้ภายนอก - ลิงก์จำนวนมากในส่วนต่อไปนี้อ้างถึงแอปพลิเคชันภายใน กรุณาพูดคุยกับทีมงานโครงการของคุณเพื่อรับการสนับสนุน
# สิ่งที่จำเป็นต้องมี
คุณจะต้องมีซอฟต์แวร์ด้านล่างที่ติดตั้งในสภาพแวดล้อมของคุณ
โหนด JS v16.x
npm v8.x+
ดูวิธีดาวน์โหลดแพ็คเกจเหล่านี้ ที่นี่ (opens new window)
# รับรองความถูกต้องของ Azure NPM Registry
ddb-js แพ็คเกจโฮสต์บน (ส่วนตัว) Azure NPM Package Registry ในการติดตั้งคุณต้องตรวจสอบสิทธิ์ดูตัวเลือกด้านล่างด้านล่าง
# หน้าต่าง
หากต้องการใช้แพ็คเกจ 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
วิธีหนึ่งที่ปลอดภัยและปลอดภัยของ Base64 การเข้ารหัสสตริงคือ:
จากคำสั่ง/เชลล์พรอมต์รัน:
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(); })"
วางค่าโทเค็นการเข้าถึงส่วนบุคคลของคุณแล้วกด ENTER/RETURN
คัดลอกค่าที่เข้ารหัส Base64
ขั้นตอนที่ 6
แทนที่ทั้งสองค่า BASE64_ENCODED_PERSONAL_ACCESS_TOKEN ในไฟล์. NPMRC ผู้ใช้ของคุณด้วยโทเค็นการเข้าถึงส่วนบุคคลของคุณจากขั้นตอนที่ 5
แทนที่ค่าทั้งสอง [อีเมล] ในไฟล์. NPMRC ผู้ใช้ของคุณด้วยอีเมลของคุณ
# การติดตั้ง
หลังจากการตรวจสอบความถูกต้องตามที่อธิบายไว้ข้างต้นแพ็คเกจ @ddb สามารถติดตั้งผ่าน NPM ได้ Microservices ทั้งหมดสามารถติดตั้งแยกกันได้
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/comments service
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) .