# Pelanggan Typescript/JavaScript DDB
Dokumentasi penuh pakej ddb-js Typescript, yang memudahkan akses ke API DDB menggunakan TypeScript.
Catatan untuk pengguna luaran - Banyak pautan dalam bahagian berikut merujuk kepada aplikasi dalaman. Sila bercakap dengan pasukan projek anda untuk mendapat sokongan.
# Prasyarat
Anda memerlukan perisian di bawah yang dipasang di persekitaran anda
- Node JS v16.x
- npm v8.x+
Lihat cara memuat turun pakej ini di sini (opens new window)
# Mengesahkan kepada pendaftaran npm azure
ddb-js Pakej dihoskan di Pakej Pakej Azure NPM (swasta). Untuk memasangnya, anda mesti mengesahkan, lihat di bawah pilihan di bawah.
# Tingkap
Untuk menggunakan pakej NPM, dapatkan NPM (yang dilengkapi dengan Node.js) dan penolong vsts-npm-auth.
Langkah 1
Langkah 2
Jalankan arahan ini
npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false
Langkah 3
Tambahkan .npmrc ke projek anda, dalam direktori yang sama dengan pakej.json anda
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Kemudian, jalankan VSTS-NPM-AUTH untuk mendapatkan token artifak Azure yang ditambahkan ke fail .npmrc peringkat pengguna anda.
vsts-npm-auth -config .npmrc
Nota: Anda tidak perlu melakukan ini setiap kali. NPM akan memberi anda kesilapan 401 yang tidak dibenarkan apabila anda perlu menjalankannya lagi. Mempunyai masalah? Lihat arahan untuk menggunakan token akses peribadi untuk mengesahkan .
# Yang lain
Langkah 1
Langkah 2
Tambahkan .npmrc ke projek anda, dalam direktori yang sama dengan pakej.json anda
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
Langkah 3
Salin kod di bawah kepada pengguna anda .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
Langkah 4
Menjana a Token akses peribadi (opens new window) Dengan pembungkusan Baca & Tulis Skop.
Langkah 5
BASE64 mengekodkan token akses peribadi dari langkah 4.
Satu kaedah yang selamat dan selamat untuk mengekodkan rentetan adalah untuk:
Dari arahan arahan/shell yang dijalankan:
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(); })"
Tampalkan nilai token akses peribadi anda dan tekan Enter/Pulangan Salin nilai yang dikodkan oleh Base64
Langkah 6
Gantikan kedua -dua nilai BASE64_ENCODED_PERSONAL_ACCESS_TOKEN dalam fail .npmrc pengguna anda dengan token akses peribadi anda dari langkah 5.
Gantikan kedua -dua nilai [e -mel] dalam fail .npmrc pengguna anda dengan e -mel anda.
# Pemasangan
Selepas mengesahkan seperti yang diterangkan di atas @ddb pakej boleh dipasang melalui npm. Semua mikroservis boleh dipasang secara berasingan
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
# Panduan Langkah Langkah
# Konfigurasi
Exmeple ini adalah untuk @ddb/komen-perkhidmatan
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)
# Menggunakan API
Semua kaedah dimulakan di kelas, dan contoh cara memanggilnya di bawah
const comments = await commentsAPI.getComments()
Rujuk antara muka TypeScript untuk memahami parameter, yang diperlukan dalam permintaan, dan juga respons dari fungsi.
Catatan: Sekiranya anda memasang Intellisense, anda akan diarahkan
# Maklumat pemaju
Repositori terletak di sini (opens new window) . Lihat bagaimana untuk menyumbang (opens new window) .