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_whitelist'라는 KVM을 만들고 업데이트합니다. KVM은 SmartDocs 프록시가 설정된 조직 및 환경에서 만들어야 합니다. 현재 배포되어 있습니다

   참고: 암호화됨 체크박스가 선택 해제되어 있어야 합니다.

   • 값이 'YES'인 'is_whitelist_ 구성'이라는 이름의 키를 추가합니다.
   • 'allowed_hosts'라는 두 번째 키를 추가합니다. 여기서 값은 공백으로 구분된 호스트 이름 또는 IP 주소입니다. SmartDocs에서 호출됩니다. 'allowed_hosts'의 값 OpenAPI 사양에 포함된 호스트를 포함해야 합니다. 을(를) SmartDocs에 추가했습니다. 예를 들어 mocktarget.apigee.net를 호출하는 OpenAPI 사양이 있는 경우 'allowed_hosts'에 mocktarget.apigee.net를 추가해야 합니다. 값으로 사용됩니다. 호스트가 포함된 경우 SmartDocs 응답은 400 Bad Request이며 콘텐츠가 포함된 Bad Request-Hostname not permitted의 페이로드.
   를 통해 개인정보처리방침을 정의할 수 있습니다. 참고: 이 KVM을 추가하고 구성하지 않으면 프록시에서 허용 목록을 적용하지 않습니다. 이 호스트와 IP 주소에 무단으로 액세스할 수 있습니다. 다음의 호스트 이름과 IP 주소만 SmartDocs로 문서화된 API 엔드포인트는 'allowed_hosts'에 포함되어야 합니다. 값으로 사용됩니다.