# DDB TypeScript/máy khách JavaScript
Tài liệu đầy đủ của gói TypeScript ddb-js, giúp đơn giản hóa quyền truy cập vào API DDB bằng TypeScript.
Lưu ý cho người dùng bên ngoài - Nhiều liên kết trong phần sau đây đề cập đến các ứng dụng nội bộ. Vui lòng nói chuyện với nhóm dự án của bạn để được hỗ trợ.
# Điều kiện tiên quyết
Bạn sẽ cần phần mềm dưới đây được cài đặt trên môi trường của bạn
Nút JS v16.x
NPM v8.x+
Xem cách tải xuống các gói này đây (opens new window)
# Xác thực với Cơ quan đăng ký Azure NPM
Các gói ddb-js được lưu trữ trên cơ quan đăng ký gói Azure NPM (riêng tư). Để cài đặt nó, bạn phải xác thực, hãy xem các tùy chọn bên dưới bên dưới.
# các cửa sổ
Để sử dụng các gói NPM, hãy lấy NPM (đi kèm với Node.js) và Trình trợ giúp vsts-npm-auth.
Bước 1
Cài đặt các điều kiện tiên quyết
Bước 2
Chạy lệnh này
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Bước 3
Thêm .npmrc vào dự án của bạn, trong cùng thư mục với gói của bạn.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Sau đó, chạy VSTS-NPM-Auth để nhận mã thông báo Azure Artifacts được thêm vào tệp .npmrc cấp độ người dùng của bạn.
vsts-npm-auth -config .npmrc
Lưu ý: Bạn không cần phải làm điều này mỗi lần. NPM sẽ cung cấp cho bạn một lỗi trái phép 401 khi bạn cần chạy lại.
Có vấn đề? Xem hướng dẫn sử dụng mã thông báo truy cập cá nhân để xác thực .
# Người khác
Bước 1
Cài đặt các điều kiện tiên quyết
Bước 2
Thêm .npmrc vào dự án của bạn, trong cùng thư mục với gói của bạn.json
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Bước 3
Sao chép mã bên dưới vào người dùng của bạn .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
Bước 4
Tạo ra a Mã thông báo truy cập cá nhân (opens new window) Với bao bì đọc và viết phạm vi.
Bước 5
Base64 mã hóa mã thông báo truy cập cá nhân từ bước 4.
Một phương thức an toàn và an toàn của base64 mã hóa một chuỗi là:
Từ lệnh nhắc lệnh/shell chạy:
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(); })"
Dán giá trị mã thông báo truy cập cá nhân của bạn và nhấn Enter/Return
Sao chép giá trị được mã hóa Base64
Bước 6
Thay thế cả hai giá trị BASE64_ENCODED_PERSONAL_ACCESS_TOKEN trong tệp .NPMRC của người dùng bằng mã thông báo truy cập cá nhân của bạn từ bước 5.
Thay thế cả hai giá trị [email] trong tệp .npmrc của bạn bằng email của bạn.
# Cài đặt
Sau khi xác thực như mô tả ở trên @ddb các gói có thể được cài đặt qua NPM. Tất cả các dịch vụ microservice có thể được cài đặt riêng
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`
# Hướng dẫn từng bước một
# Cấu hình
Exmaple này dành cho @ddb/bình luận-dịch vụ
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)
# Sử dụng API
Tất cả các phương pháp được bắt đầu trên lớp và ví dụ về cách gọi chúng bên dưới
const comments = await commentsAPI.getComments()
Tham khảo các giao diện TypeScript để hiểu các tham số, được yêu cầu trong yêu cầu và cả các phản hồi trở lại từ hàm.
Lưu ý: Nếu bạn đã cài đặt Intellisense, bạn sẽ được hướng dẫn
# Thông tin nhà phát triển
Kho lưu trữ được đặt đây (opens new window) . Xem làm thế nào để đóng góp (opens new window) .