API Gateway에서 HTTP API 내보내기

HTTP API를 생성한 후 API Gateway에서 API의 OpenAPI 3.0 정의를 내보낼 수 있습니다. 내보낼 스테이지를 선택하거나 API의 최신 구성을 내보낼 수 있습니다. 내보낸 API 정의를 API Gateway로 가져와 동일한 또 다른 API를 생성할 수도 있습니다. API 정의 가져오기에 대한 자세한 내용은 HTTP API 가져오기 단원을 참조하세요.

AWS CLI를 사용하여 스테이지의 OpenAPI 3.0 정의 내보내기

다음 명령은 prod라는 API 단계의 OpenAPI 정의를 stage-definition.yaml이라는 YAML 파일로 내보냅니다. 내보낸 정의 파일에는 기본적으로 API Gateway 확장이 포함됩니다.

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type YAML  \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

AWS CLI를 사용하여 API의 최신 변경 사항에 대한 OpenAPI 3.0 정의 내보내기

다음 명령은 HTTP API의 OpenAPI 정의를 latest-api-definition.json이라는 JSON 파일로 내보냅니다. 이 명령은 스테이지를 지정하지 않으므로 API Gateway는 스테이지에 배포되었는지 여부에 관계없이 API의 최신 구성을 내보냅니다. 내보낸 정의 파일에는API Gateway 확장이 포함되지 않습니다.

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type JSON  \
    --specification OAS30 \
    --no-include-extensions \
    latest-api-definition.json

자세한 내용은 Amazon API Gateway 버전 2 API 참조의 ExportAPI를 참조하세요.

API Gateway 콘솔을 사용하여 OpenAPI 3.0 정의 내보내기

다음 절차에서는 HTTP API의 OpenAPI 정의를 내보내는 방법을 보여줍니다.

API Gateway 콘솔을 사용하여 OpenAPI 3.0 정의를 내보내려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. HTTP API를 선택합니다.

3. 기본 탐색 창의 개발에서 내보내기를 선택합니다.

4. API 내보내기를 위한 다음과 같은 옵션을 선택합니다.

   

   1. 소스에서 OpenAPI 3.0 정의의 소스를 선택합니다. 내보낼 스테이지를 선택하거나 API의 최신 구성을 내보낼 수 있습니다.

   2. API Gateway 확장을 포함하려면 API Gateway 확장 포함을 켭니다.

   3. 출력 형식에서 출력 형식을 선택합니다.

5. 다운로드를 선택합니다.