OpenAPI를 사용한 REST API 문서 생성

<server>
   <featureManager>
      <feature>openapi-3.0</feature>
   </featureManager>
</server>

API가 개인용으로 유지되도록 지정할 수 있습니다. 관리용 API는 일반적으로 개인용으로 유지됩니다. 보호용 비밀번호를 사용하는 개인용 API는 /ibm/api/docs 자원에 문서화되어 있습니다. 이 자원은 모든 개인용 API 및 모든 공용 API를 문서화합니다.

다음 두 가지 방법으로 웹 애플리케이션에 대한 개인용 API를 지정할 수 있습니다.

• public속성이 false로 설정된 서버 구성에서 webModuleDoc를 사용하십시오.
  1. openapi 요소를 추가하고 해당 enablePrivateURL 부울 속성을 true로 설정하십시오.
  2. 각 웹 애플리케이션에 대한 webModuleDoc 하위 요소를 추가하고 공용 API의 경우 public 부울 속성을 true로 설정하고 개인용 API의 경우 false로 설정합니다.

  다음 예제는 airlines 애플리케이션 OpenAPI를 표시하고 airlinesAdmin 애플리케이션 OpenAPI의 노출을 사용 안함으로 설정합니다.

  
  <openapi enablePrivateURL="true">
    <webModuleDoc contextRoot="/airlines" public="true" />
    <webModuleDoc contextRoot="/airlinesAdmin" public="false" />
  </openapi>
  

  기본적으로 webModuleDoc의 public 속성은 true로 설정됩니다. 이 구성은 개인용으로 유지하려는 애플리케이션을 사용 안함으로 설정하는 경우에만 필요합니다.

• API 설명의 벤더 확장 키워드를 사용하여 API를 개인용으로 지정하십시오.
  1. 서버 구성에 openapi 요소를 추가하고 해당 enablePrivateURL 부울 속성을 true로 설정하십시오.
  2. 키워드와 x-ibm-private: true 값을 API 설명 문서 META-INF/openapi.yaml 파일 또는 다른 지원되는 형식의 파일에 넣어주세요. 이 값은 API의 기본 가시성을 대체하며 이 값을 webModuleDoc 항목으로 대체할 수 있습니다.

contextRoot 속성을 사용하여 숨기거나 표시할 웹 모듈을 식별하십시오. 그런 다음 enabled 속성을 false로 변경하여 OpenAPI 문서에서 웹 모듈을 숨기십시오. enabled 속성의 기본값은 true입니다. 다음 예제는 airlinesAdmin 모듈이 숨겨져 있는 동안 OpenAPI 문서에 나타나도록 airlines 모듈을 구성합니다.

<openapi>
  <webModuleDoc contextRoot="/airlines" enabled="true" />
  <webModuleDoc contextRoot="/airlinesAdmin" enabled="false" />
</openapi>

<application id="scholar" name="Scholar" type="ear" location="scholar.ear">
  <classloader apiTypeVisibility="spec, ibm-api, stable, third-party" commonLibraryRef="Alexandria" />
</application>