콘텐츠로 이동

개요


Guance External API는 간소화된 HTTP REST API입니다.

  • GET / POST 요청만 지원합니다.
  • 리소스 지향 URL을 사용하여 API를 호출합니다.
  • 상태 코드를 사용하여 요청 성공 또는 실패를 나타냅니다.
  • 모든 요청은 JSON 구조를 반환합니다.
  • External API는 프로그래밍 방식으로 Guance 플랫폼을 관리합니다.

지원되는 Endpoint

배포 유형 노드 이름 Endpoint
프라이빗 배포 플랜 프라이빗 배포 플랜 실제 배포된 Endpoint를 기준으로 하며, 일반적으로 https://external-api.guance.com

API 문서 설정

  1. 인터페이스 문서 주소는 고정되어 있습니다: \/v1/doc
    예: https://external-api.guance.com/v1/doc

  2. API 문서 스위치 설정은 launcher의 core(네임스페이스: forethought-core) 설정에 있습니다. 구체적인 설정은 다음과 같습니다.

    # API 문서
    apiDocPageSwitch:
      # external API 인터페이스 문서 페이지 스위치, true: 활성화, false: 비활성화. 기본값 `false`
      external: true
    

서비스 설정 항목

선택 사항인 설정 항목은 launcher의 core(네임스페이스: forethought-core) 설정에 있습니다. 구체적인 선택 설정은 다음과 같습니다.

# external-api 서비스의 설정 항목
external:
  # 각 요청 서명의 유효 기간(단위: 초), 기본값 60초
  timeliness: 60
  # 접근자 식별자로, 인터페이스 요청 헤더의 `X-Df-Access-Key` 값에 해당합니다. 비어 있지 않은 문자열
  accessKey: ""
  # 서명 계산에 사용되는 키
  secretKey: ""

현재 리포지토리 내 초안 문서

설명: 템플릿 관리 문서는 현재 backend 리포지토리에 출시 전 초안으로 우선 배치되어 있습니다. 기능 개발이 완료되어 이터레이션 출시 당일에 정식 도움말 문서 프로젝트 저장소로 동기화합니다.

문서 평가

이 페이지가 도움이 되었나요?