pontjs/pontx-hub

Pontx Hub

pontx-hub를 사용하여 큐레이팅된 API 카탈로그에 대한 신뢰할 수 있는 인터페이스로 활용하세요. API 메타데이터를 장기 컨텍스트에 보관하지 말고, 현재 작업에 필요한 제품, 엔드포인트 또는 스키마만 검색하여 로드하세요.

워크플로

1. API를 선택하기 전에 검색하세요. 자연어 기능, 요청 및 응답 질문을 지원합니다:

   pontx-hub search "<capability>" --json
   pontx-hub search "创建任务的入参" --locale zh --json
   pontx-hub search "返回 dueDate 的接口" --locale zh --json
   

   필요시 결과 유형을 좁히세요:

   pontx-hub search "<field-or-model>" --type schema --json
   

2. 선택한 안정적인 리소스 ID를 검사하세요:

   pontx-hub show endpoint:<api>/<endpoint>
   pontx-hub show schema:<api>/<schema>
   

3. 엔드포인트의 경우, 전송하지 않고 정확한 요청을 빌드하고 검토하세요:

   pontx-hub <api-collection> preview <api-name> --parameter value --body '<json>'
   pontx-hub <api-collection> preview <controller> <api-name> --parameter value --body '<json>'
   

4. GET 또는 HEAD의 경우, 사용자가 실행을 요청한 경우에만 호출하세요:

   pontx-hub <api-collection> call <api-name> --parameter value
   pontx-hub <api-collection> call <controller> <api-name> --parameter value
   

5. POST, PUT, PATCH 또는 DELETE의 경우, dry-run 결과를 보여주고 명시적인 사용자 승인을 받으세요. 그런 다음 매개변수를 변경하지 않고 --yes를 전달하세요:

   pontx-hub <api-collection> call <controller> <api-name> --parameter value --body '<json>' --yes
   

6. 요청 형태가 확인된 후 통합 코드를 생성하세요:

   pontx-hub sdk <api>
   

안전

• API 검사, 설명 또는 미리보기 요청을 쓰기 작업에 대한 승인으로 추정하지 마세요.
• 자격 증명을 명령 인수에 직접 출력, 에코, 로깅 또는 배치하지 마세요.
• show가 지정한 환경 변수에서 자격 증명을 읽으세요.
• Hub 카탈로그 외부의 임의 URL이나 작업을 호출하지 마세요.
• 변경 작업에 대해 별도의 preview 단계를 우회하지 마세요.
• 변경된 매개변수, 본문, 서버 또는 작업은 새로운 요청으로 간주하여 다시 dry-run 및 확인이 필요합니다.
• 자격 증명을 구성하거나, 인증 문제를 진단하거나, 변경 작업을 실행할 때는 references/auth-and-safety.md를 참조하세요.

출력

CLI 출력을 프로그래밍 방식으로 사용할 때는 --json을 선호하세요. 실패 보고 시 CLI 종료 코드와 기계 판독 가능 오류 코드를 유지하세요. 결과의 match.mode 및 match.fields를 사용하여 제품, 매개변수, 요청, 응답, 스키마 또는 속성 메타데이터 중 어떤 항목이 일치를 생성했는지 설명하세요. 애플리케이션 코드를 생성할 때는 작업의 게시된 @pontx/<api-slug> 패키지를 사용하세요.