SmartDocs 설치하기

SmartDocs는 설치 테스트에 설명된 설치 테스트 스크립트를 설치하고 실행하면 자동으로 설치됩니다. 테스트 스크립트를 실행하는 과정에서 다음 명령어를 실행합니다.

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

여기서 configFile는 Edge를 설치하는 데 사용한 구성 파일과 동일합니다. 자세한 내용은 노드에 Edge 구성요소 설치하기를 참고하세요.

이 명령어는 테스트를 실행하는 과정에서 SmartDocs를 설치합니다.

설치를 완료하려면 다음 단계를 따르세요.

  1. smartdocs.zip 파일이 다음 디렉터리에 있는지 확인하여 SmartDocs가 설치되어 있는지 테스트합니다.

    /opt/apigee/apigee-validate/bundles/

    또는 관리 서버 노드에서 다음 API 호출을 실행합니다.

    curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

    SmartDocs가 설치되어 있는 경우 이 명령어는 다음을 반환합니다.

    [ "smartdocs", "passthrough" ]
  2. Edge UI에서 아래 그림과 같이 'smartdocs_화이트'로 KVM을 만들고 업데이트합니다. KVM은 현재 SmartDocs 프록시가 배포된 조직 및 환경에서 만들어야 합니다.

    참고: 암호화됨 체크박스가 선택되지 않았는지 확인합니다.

    • 값이 'YES'인 'is_허용된_구성' 키를 추가합니다.
    • 이름이 'allowed_hosts'인 두 번째 키를 추가합니다. 여기서 값은 공백으로 구분된 호스트 이름 또는 SmartDocs에서 호출된 IP 주소입니다. 'allowed_hosts'의 값은 SmartDocs에 추가된 OpenAPI 사양에 포함된 모든 호스트를 포함해야 합니다. 예를 들어 mocktarget.apigee.net를 호출하는 OpenAPI 사양이 있으면 'allowed_hosts' 값에 mocktarget.apigee.net를 추가해야 합니다. 호스트가 KVM에 포함되지 않으면 SmartDocs 응답은 400 Bad Request이고 콘텐츠 페이로드는 Bad Request-Hostname not permitted입니다.
    KVM 생성 인터페이스 참고: 이 KVM을 추가하고 구성하지 않으면 프록시가 허용 목록을 적용하지 않습니다. 이로 인해 호스트 및 IP 주소에 무단으로 액세스할 수 있습니다. SmartDocs와 함께 기록된 API 엔드포인트의 호스트 이름과 IP 주소만 'allowed_hosts' 값에 포함되어야 합니다.