# DDB TypeScript/JavaScript 클라이언트
TypeScript를 사용하여 DDB API에 대한 액세스를 단순화하는 ddb-js 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 단계
Package.json과 동일한 디렉토리에서 프로젝트에 .NPMRC를 추가하십시오.
@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true
그런 다음 VSTS-NPM-Auth를 실행하여 사용자 수준 .NPMRC 파일에 Azure Artifacts 토큰을 추가하십시오.
vsts-npm-auth -config .npmrc
참고 : 매번이 작업을 수행 할 필요가 없습니다. NPM은 다시 실행해야 할 때 401 무단 오류를 제공합니다. 문제가 있습니까? 인증을 위해 개인 액세스 토큰을 사용하는 지침을 참조하십시오. .
# 기타
1 단계
2 단계
Package.json과 동일한 디렉토리에서 프로젝트에 .NPMRC를 추가하십시오.
@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 단계
생성 a 개인 액세스 토큰 (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 단계
사용자 .npmrc 파일의 BASE64_ENCODED_PERSONAL_ACCESS_TOKEN 값을 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/comment-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) .