새 REST OpenAPI 정의 작성

온라인에서 편집하기

IBM® API Connect 의 API Designer 또는 API Designer 사용자 인터페이스를 사용하여 REST API 정의 초안을 생성하고 편집할 수 있습니다.

이 태스크에 대한 정보

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

API Manager UI 전용: 이 태스크를 완료하려면 Api-Drafts:Edit 권한이 있는 역할이 지정되어야 합니다. 사전 제공된 개발자 역할에는 기본적으로 이 권한이 있습니다. 사용자 정의 역할이 지정된 경우 해당 역할에 이 권한이 있어야 합니다. 자세한 정보는 사용자 정의 역할 작성을 참조하십시오.

프로시저

새 REST OpenAPI 정의를 작성하려면 다음 단계를 완료하십시오.
  1. 탐색 창에서 [개발 ]을 API UI 탐색 분할창의 개발 아이콘 클릭한 다음 [추가 ] > [API]를 클릭합니다.
    API 유형 선택 화면이 표시됩니다.
  2. API의 기반이 될 OpenAPI 스펙의 버전에 따라 OpenAPI 2.0 또는 OpenAPI 3.0 을 선택하십시오.
  3. 새 OpenAPI 를 선택하십시오.
  4. 다음을 클릭하십시오. 정보 섹션에서 API 요약을 지정하십시오. API가 작성된 후 미세 조정할 수 있습니다.
    • 제목은 특수 문자를 포함할 수 있지만 사용자 인터페이스에서 쉽게 표시할 수 있도록 짧게 유지해야 합니다.
    • 이름 이 자동으로 입력됩니다. 이름 필드의 값은 개발자 툴킷 CLI 명령에서 API를 식별하는 데 사용되는 단일 문자열입니다. 초안 API를 관리하는 CLI 명령어를 확인하려면 툴킷 CLI 참조 문서를 참조하십시오.
    • 버전 은 API OpenAPI 정의의 info.version 특성 값에 해당합니다. version.release.modification 버전 번호 지정 체계를 사용하는 것이 좋습니다(예: 1.0.0).
    • 기본 경로는 API의 URL 세그먼트이며 경로 또는 오퍼레이션에 대한 추가 세그먼트 또는 호스트 이름을 포함하지 않습니다. 기본 경로는 특수 문자를 포함할 수 없으며 / 문자로 시작해야 합니다. 경로가 비어 있는 경우에도 마찬가지입니다.
    • 선택적 설명은 API를 식별하는 데 도움이 됩니다.
  5. 다음을 클릭하십시오. 보안 섹션에서 사용자에게 필요한 API 보안을 구성하십시오.
    • 클라이언트 ID를 사용한 보안 설정 - 애플리케이션이 클라이언트 ID(API 키)를 제공하도록 요구하려면 이 옵션을 선택하십시오. 그러면 X-IBM-Client-Id 매개변수가 API의 요청 헤더에 포함됩니다. 선택된 경우, 각각의 키(각각의 클라이언트 ID) 기준으로 API 호출 수를 제한할지 여부를 선택할 수 있습니다.
      • 키 기준으로 API 호출 제한 - 선택된 경우 사용자에게 필요한 비율 한계를 구성해야 합니다. 비율 한계는 기간(시, 분, 월, 일) 내에 허용된 최대 호출 수를 제어합니다. 예를 들어 시간당 100개 호출입니다.
    • CORS - API에 대한 CORS(Cross-Origin Resource Sharing) 지원을 사용으로 설정하려면 이 옵션을 선택하십시오. 이 옵션을 사용하면 다른 도메인에서 API에 액세스할 수 있습니다.
      참고:
      • CORS 이 기능은 에서만 이용할 수 DataPower® API Gateway 있습니다.
      • CORS가 활성화되면 API Gateway는 cors 프리플로우 정책을 실행하여 API에 대한 모든 CORS 요청을 처리합니다.
      • CORS가 활성화되고 프리플라이트 요청이 수신되면 다음 API 조치만 수행됩니다.
        • cors 프리플로우 정책이 적절한 응답 헤더를 구성합니다.
        • 응답 헤더가 설정됩니다.
      • 프리플라이트 요청이 수신되면 request.attributes.isCORSPreflight 플래그가 true로 설정됩니다.
      • 모든 프리플라이트 요청의 경우, ` CORS ` security 가 활성화되었는지 여부와 관계없이 ` client-identification preflow` 정책은 항상 건너뜁니다.
  6. 다음 을 클릭하여 API 정의를 작성하십시오.

    요약 패널이 정의가 작성되었다는 메시지를 표시하고 선택된 보안 옵션 및 비율 한계가 적용됩니다.

  7. 다음 옵션 중 하나를 선택하십시오.
    • API를 추가 구성하려면 API 편집을 클릭하십시오. 세부사항은 API 정의 편집을 참조하십시오.
    • 현재 API를 추가로 구성하지 않으려면 이동 경로 추적에서 개발 링크를 클릭하여 시작 페이지로 돌아가십시오. 그런 다음 다른 태스크로 즉시 이동할 수 있습니다. 나중에 API를 구성하는 방법에 대한 세부사항은 API 정의 편집을 참조하십시오.

결과

REST API 정의를 작성했습니다. API Designer의 경우, API및 제품의 스펙은 로그인할 때 지정한 디렉토리에 저장됩니다. API Manager의 경우 API및 제품에 대한 스펙은 관리 서버에 저장됩니다.

다음에 수행할 작업

API를 제품에 포함시키고 해당 제품을 카탈로그에 공개하면 애플리케이션 개발자가 API를 사용할 수 있게 됩니다. 자세한 내용은 ‘제품 작업’ 및 ‘카탈로그 작업’을 참조하십시오.