Javadoc 생성 및 액세스

기본적으로 Javadoc은 런타임 이미지 또는 추출된 런타임 디렉토리의 일부가 아닙니다. 액세스하려면 Javadoc 파일을 생성해야 합니다.

시작하기 전에

사용자 정의 확장 업데이트에 설명된 대로 추출된 런타임의 사본이 있는지 확인하십시오.

태스크 정보

Javadoc은 런타임 이미지 또는 추출된 런타임 디렉토리의 일부가 아닙니다. 액세스할 수 있으려면 먼저 이를 생성해야 합니다.

프로시저

  1. Javadoc 파일을 생성하려면 extracted_runtime/bin 폴더를 찾아보고 다음 명령을 실행하십시오.
    bash ./sci_ant.sh -f ../properties/xapiDeployer.xml alldocs
  2. extracted_runtime/xapidocs 폴더로 이동하십시오.
  3. 액세스하려는 문서 유형에 따라 해당 디렉토리에서 index.html 파일을 여십시오. 예를 들어, api_javadocs, propertydocs또는 cufdocs입니다.

    이 위치의 swaggerdoc 폴더는 Sterling™ Order Management 시스템의 모든 REST API에 대한 자세한 대화형 개요를 제공합니다. OpenAPI Swagger 문서는 API 엔드포인트, 요청 및 응답 스키마, 매개변수, 인증 세부 정보를 OpenAPI 3.0–compliant 형식으로 표준화된 표현으로 제공함으로써 기존 Javadoc을 보완합니다.

    참고: doc EAR을 배치할 수 없습니다. 대신 xapidocs 폴더에서 Javadoc 파일에 액세스할 수 있습니다.