래퍼 API 사양 및 Postman 컬렉션 생성

블록체인 앱 빌더를 사용하여 필터링된 토큰 및 계정/ID 엔드포인트 사양 파일과 일치하는 Postman 컬렉션을 생성할 수 있습니다.

package.json 파일에 hardhat-plugin-obp-besu-wrapper-api가 포함되어 있고 Hardhat 구성이 임포트하는지 확인합니다. 매니페스트 및 컴파일된 토큰/계정 아티팩트가 포함된 생성된 토큰 패키지를 선택합니다. 이 도구는 생성된 매니페스트에서 작성된 패키지를 검색하고 호환되는 가져온 참조 프로젝트 매니페스트를 지원합니다. 래퍼 API 서비스를 배치하거나 시작하지 않습니다. 래퍼 API 서비스가 인스턴스 설정의 일부로 이미 실행되었습니다.

1. 토큰 및 계정 사양을 생성합니다.
   1. 개발자 도구를 열고 래퍼 API 사양 및 포스트맨 모음 생성을 선택합니다.
   2. 구성에서 Hardhat 프로젝트, 토큰 패키지 및 프로젝트 내의 출력 폴더를 선택합니다.
   3. 매핑에서 토큰 API 및 계정/ID API를 검토합니다. 끝점 사양에 유지될 각 메소드에 대해 래퍼 API 생성을 선택된 상태로 유지합니다. 필요한 경우 끝점 경로를 편집합니다.
   4. 필터링된 토큰 및 계정 사양 JSON 파일과 Postman 모음을 작성하려면 생성을 선택합니다.
2. ORDS Swagger/OpenAPI 끝점을 추가합니다.
   1. 매핑 뷰에서 ORDS API를 선택했습니다. 이 도구는 ORDS API 입력만 지원합니다.
   2. ORDS Swagger/OpenAPI JSON 파일을 선택합니다.
   3. 래퍼 자산을 다시 생성합니다.
3. 선택된 토큰 또는 계정 메소드를 하나의 래퍼 API 끝점으로 결합하는 순차적 워크플로우를 정의하는 결합된 API를 생성합니다.
   1. 매핑에서 적격한 각 방법에 대해 결합된 API에 사용을 선택합니다.
   2. 결합 API 생성을 선택합니다.
   3. 결합된 API 이름과 끝점 경로를 입력합니다.
   4. 선택한 단계를 검토하고 순서를 재지정합니다. 각 단계에 대해 요청-페이로드 소스 필드를 매핑합니다.
   5. 결합된 API 초안을 저장한 다음 생성을 선택합니다.
4. 래퍼 API 서비스에 사양을 등록합니다.
   1. 래퍼 API 서비스가 실행 중인지 확인하고 배치 탭을 선택합니다.
   2. 생성된 토큰 사양, 계정 사양, 두 사양을 선택하거나 사용자정의 JSON 본문을 제공하십시오.
   3. 래퍼 API 호스트 URL을 입력합니다.
   4. 요청이 인증 및 TLS 설정을 재사용할 수 있도록 Oracle Blockchain Platform Besu 환경을 선택합니다.
   5. 등록 미리보기를 검토하고 선택한 사양을 등록합니다.

등록은 래퍼 API 서비스의 /register 끝점에 게시합니다. 이 도구는 선택한 Oracle Blockchain Platform 환경의 개인 CA 경로 또는 등록 요청에 대한 명시적 자체 서명 설정을 사용할 수 있으며 서비스 자체를 배포하지 않습니다.

문제 해결

조건	해결
아티팩트 또는 매니페스트가 누락되었습니다.	선택한 프로젝트를 컴파일하고 생성된/임포트된 패키지 파일이 있는지 확인합니다.
생성된 끝점이 없습니다.	래퍼 API 생성에 대한 메소드를 하나 이상 선택하거나 적합한 결합된 API를 하나 이상 저장하십시오.
ORDS 생성을 실패했습니다.	ORDS Swagger/OpenAPI JSON 파일을 제공하고 프로젝트 플러그인이 --ords-swagger 옵션을 지원하는지 확인합니다. 전체 플러그인 로그에서 스키마 또는 작업 오류를 검사합니다.
결합된 API가 거부되었습니다.	API 이름/경로, 정렬된 단계 및 요청-필드 매핑을 확인한 다음 초안을 다시 저장하십시오.
등록을 사용할 수 없습니다.	먼저 끝점 사양 파일을 생성한 다음 Oracle Blockchain Platform Besu 환경을 선택하고 연결 가능한 래퍼 API 호스트 URL을 제공합니다.