독립형 Node.js 앱 배포

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

이 주제에서는 로컬 시스템에서 Apigee Edge로 Node.js 애플리케이션을 배포하는 방법을 설명합니다. 이 주제에서는 apigeetool이라는 명령줄 도구를 사용하여 Node.js 애플리케이션을 Apigee Edge에 배포하는 방법을 설명합니다.

Apigee Edge에 Node.js 코드 배포 정보

apigeetool라는 명령줄 유틸리티를 사용하여 로컬 시스템에서 Apigee Edge로 종속 Node.js 모듈을 포함한 기존 Node.js API 애플리케이션을 배포할 수 있습니다. 이 유틸리티는 자동으로 애플리케이션과 종속 항목을 API 프록시로 번들로 묶어 Edge에 배포합니다.

예를 들어 Express를 사용하여 Node.js로 웹 애플리케이션을 만든다고 가정해 보겠습니다. 애플리케이션은 HTTP 요청을 수신 대기하고, 해당 요청을 처리하고, 데이터를 반환하는 HTTP 서버로 실행됩니다. apigeetool을 사용하여 Node.js 애플리케이션을 Edge에 배포하면 해당 애플리케이션이 프록시로 래핑되고 Edge 플랫폼의 컨텍스트 내에서 실행됩니다. 그런 다음 새 프록시 URL을 통해 애플리케이션을 호출하고 OAuth 보안, 할당량 정책, 위협 보호 정책, 조건부 흐름, 캐싱 등과 같은 표준 Edge 기능으로 '보상'하여 애플리케이션에 가치를 더할 수 있습니다.

Apigeetool의 기능은 무엇인가요?

deploynodeapp 옵션으로 apigeetool 유틸리티를 실행하면 다음을 충족해야 합니다.

  • Node.js 애플리케이션을 수용할 API 프록시 구성 번들을 생성합니다.
  • NPM (노드 패키지 모듈)과 함께 설치된 Node.js 패키지로 Node.js 애플리케이션을 패키징합니다.
  • Edge 관리 API를 사용하여 API 프록시 구성 번들을 Apigee Edge의 지정된 조직으로 가져옵니다.
  • API 프록시를 환경에 배포합니다.
  • Apigee Edge에서 Node.js 애플리케이션을 실행하고 네트워크를 통해 사용할 수 있도록 합니다.

Apigeetool 사용 준비 중

시작하기 전에 apigeetool 유틸리티를 설치해야 합니다.

npm을 사용하거나 GitHub에서 코드를 클론하고 연결하여 apigeetool을 설치할 수 있습니다.

npm에서 설치

apigeetool 모듈 및 종속 항목은 Node.js용으로 설계되었으며 다음 명령어를 사용하여 npm을 통해 사용할 수 있습니다.

$ sudo npm install -g apigeetool

일반적으로 -g 옵션은 *nix 기반 머신에서 모듈을 /usr/local/lib/node_modules/apigeetool에 배치합니다.

GitHub에서 설치

GitHub에서 API 플랫폼 도구를 다운로드하거나 클론합니다. 설치 안내는 저장소 루트 디렉터리의 README 파일을 참조하세요.

$ git clone https://github.com/apigee/apigeetool-node.git

설치를 완료했으면 apigeetool 실행 파일이 경로에 있는지 확인합니다. 다음을 입력하여 테스트할 수 있습니다.

$ apigeetool -h

Apigeetool을 사용하여 Edge에 Node.js 애플리케이션 배포

참고: 배포하기 전에 Apigee Edge 조직 이름, 사용자 이름, Apigee Edge 계정의 비밀번호를 알아야 합니다. apigeetool 명령어를 올바르게 구성하는 데 이 정보가 필요합니다.

apigeetool를 사용하여 Node.js 애플리케이션을 배포하려면 다음 안내를 따르세요.

  1. 터미널 창에서 Node.js 애플리케이션의 루트 디렉터리를 cd합니다.
  2. deploynodeapp 명령어를 사용하여 apigeetool 유틸리티를 실행합니다.

    $ apigeetool deploynodeapp -n {A name for your new proxy} -d {The root directory of your Node.js app} -m {The name of the main Node.js file} -o {Your org name on Edge} -e {The environment to deploy to} -b {The base URL for your proxy} -u {Your Edge email address} -p {Your Edge password}
    
    예:

    $ apigeetool deploynodeapp -n myNodeApp -d . -m server.js -o myorg -e test -b /myNodeApp -u ntesla -p myPassword
    
  3. 터미널 창에서 출력을 확인합니다. 표시되는 방식은 다음과 같습니다.

    Importing new application myNodeApp
    Imported new app revision 1
    Deploying revision 1
      Deployed.
    Proxy: "myNodeApp" Revision 1
      Environment: test BasePath: /myNodeApp
      Status: deployed
    

    'Status: Deploy(상태: 배포됨)'가 표시되면 완료된 것입니다. 모든 것이 원활하게 진행되었습니다. Node.js 앱이 API 프록시로 래핑되고 Edge에 배포되며, 실행 중이며 요청 처리를 위해 대기합니다. 테스트할 준비가 되었습니다.

  4. 프록시를 테스트합니다. 예를 들면 다음과 같습니다.

    $ curl http://myorg-test.apigee.net/myNodeApp
    Hello, My Node App!
    
  5. 원하는 경우 Apigee Edge 계정에 로그인하여 관리 UI의 API 프록시 페이지로 이동합니다. 새 프록시가 목록에 표시됩니다.

Apigeetool이 종속 파일과 모듈을 처리하는 방법

Node.js 애플리케이션이 설치된 모듈에 종속되는 경우 apigeetool은 node_modules 폴더를 압축하고 프록시 번들에 추가하여 모듈을 처리합니다. 별도의 조치는 필요하지 않습니다. 추가 소스 코드가 포함된 디렉터리도 마찬가지입니다. Apigeetool 유틸리티에서 이 파일을 압축하여 번들과 함께 배포합니다.

에지 관리 UI의 편집기에서는 이렇게 압축된 디렉터리에 있는 파일을 수정할 수 없습니다. 변경해야 하는 경우 프로젝트를 내보내고 파일을 로컬에서 수정한 후 apigeetool을 사용하거나 관리 UI를 사용하여 내보낸 프로젝트를 가져와 다시 배포할 수 있습니다. 'Node.js 코드로 프록시 내보내기 및 가져오기'도 참조하세요.

Apigeetool의 기본 사용 정보

apigeetool 유틸리티의 입력 매개변수에 관한 기본 사용법 정보를 보려면 다음을 입력하세요.

$ apigeetool deploynodeapp -h

  Usage: deploynodeapp -n [name] -o [organization] -e [environment]
  -d [directory name] -m [main script file]
  -u [username] -p [password]
  -b [base path] -l [apigee API url] -z [zip file] -i -h
  -o Apigee organization name
  -e Apigee environment name
  -n Apigee proxy name
  -d Apigee proxy directory
  -m Main script name: Should be at the top level of the directory
  -u Apigee user name
  -p Apigee password
  -b Base path (optional, defaults to /)
  -L Apigee API URL (optional, defaults to https://api.enterprise.apigee.com)
  -z ZIP file to save (optional for debugging)
  -i import only, do not deploy
  -R Resolve Node.js modules on Apigee Edge. Equivalent to running npm install on your project. 
  -U Uploads Node.js modules to Apigee Edge. 
  -h Print this message

기존 Node.js 파일로 새 프록시 만들기

기존 Node.js 애플리케이션을 API 프록시에 통합하는 또 다른 방법은 프록시를 만들 때 애플리케이션을 추가하는 것입니다. 이 작업은 전적으로 관리 UI 및 새 API 프록시 대화상자를 통해 수행할 수 있습니다.

  1. API 프록시 요약 페이지에서 +API 프록시를 클릭합니다.
  2. 새 API 프록시 대화상자에서 기존 Node.js를 선택합니다.
  3. Choose Files 버튼을 사용하여 가져올 Node.js 파일을 하나 이상 선택합니다.
  4. 프록시 이름을 지정합니다. 이 예에서는 hellonode라고 합니다.
  5. /v1 버전을 프로젝트 기본 경로에 추가합니다. API의 버전 관리를 권장합니다.
  6. 빌드를 클릭합니다.
  7. 개발을 클릭하여 개발 보기로 전환합니다.
  8. 코드 편집기에서 TargetEndpoint 파일을 엽니다.
  9. <ScriptTarget> 요소가 기본 Node.js 파일을 다음과 같이 지정하는지 확인합니다.


    <ScriptTarget>
            <ResourceURL>node://server.js</ResourceURL>
            <Properties/>
    </ScriptTarget>
    
  10. 저장을 클릭합니다.

새 Node.js 리소스 파일 추가 및 호출

Node.js 코드를 프록시에 추가하는 또 다른 방법은 UI를 통해 또는 로컬 파일 시스템에서 업로드하여 Node.js 코드를 직접 추가하는 것입니다. 기본 파일로 사용할 Node.js 파일도 지정할 수 있습니다. 이 파일은 프록시가 배포될 때 Edge에서 호출하는 파일입니다.

UI를 통해 새 Node.js 파일 추가

관리 UI를 사용하면 Edge 플랫폼에 있는 프록시에 Node.js 소스 파일을 추가할 수 있습니다. UI에서 직접 만들거나 파일 시스템에서 가져올 수 있습니다. 먼저 UI에서 이 작업을 실행하는 방법을 살펴보겠습니다.

새 Node.js 리소스 파일을 만들려면 다음 안내를 따르세요.

  1. 개발 뷰의 새로 만들기 메뉴에서 새 스크립트를 선택합니다.
  2. 스크립트 추가 대화상자에서 파일 형식 노드를 선택하고 스크립트의 이름을 지정합니다.
  3. Add를 클릭합니다.

비어 있는 새 Node.js 파일이 편집기에서 열립니다. 코드를 잘라서 파일에 붙여넣을 수 있습니다. 이 파일은 탐색기의 스크립트 섹션에도 나타납니다.

[[{"type":"media","view_mode":"media_large","fid":"2431","attributesqwiklabsalt":"","class":"media-image","height":"312","typeof":"foaf:Image","width":"417"}}]]

파일 시스템에서 Node.js 파일 가져오기

파일 시스템에서 프록시로 Node.js 파일을 import 다음 안내를 따르세요.

  1. 개발 뷰의 새로 만들기 메뉴에서 새 스크립트를 선택합니다.
  2. 스크립트 추가 대화상자에서 스크립트 가져오기를 클릭합니다.
  3. 파일 도구를 사용하여 Node.js 파일을 선택합니다.
  4. 대화상자에 파일 이름이 추가되지만 원하는 경우 이름을 변경할 수 있습니다.
  5. Add를 클릭합니다. 파일이 탐색기의 스크립트 섹션에 표시되고 편집기에서 열립니다.
  6. 저장을 클릭합니다.

가져온 파일을 호출하려면 다음 섹션에 설명된 대로 추가 단계가 필요합니다.

가져온 Node.js 파일 호출

새로 가져오거나 만든 Node.js 파일을 호출할 수는 없습니다. Edge에서 main 파일 하나를 사용해야 하기 때문입니다. 기본 파일은 대상 엔드포인트 정의의 <ScriptTarget> 요소에 지정됩니다. 기본 Node.js 파일을 지정할 파일을 지정하려면 다음을 수행합니다.

  1. 탐색기의 대상 엔드포인트 아래에서 대상 엔드포인트의 이름 (일반적으로 기본값)을 클릭합니다.
  2. 코드 편집기에서 기본 Node.js 파일로 사용할 파일의 이름이 반영되도록 <ResourceURL>을 변경하여 <ScriptTarget> 요소를 수정합니다. 예를 들어 hello-world.js라는 파일을 기본 파일로 만들려면 ResourceURL 요소에 node://hello-world.js를 입력합니다.
  3. 저장을 클릭합니다.

이 시점에서 이전에 사용했던 프록시 경로로 파일을 호출할 수 있습니다. 예를 들어 여기서는 기본 경로 v1/hello가 지정된 Hello World! 예를 살펴봤습니다. 하지만 프록시 엔드포인트를 수정하여 기본 경로를 변경할 수 있습니다.

  1. 탐색기의 프록시 엔드포인트 아래에서 프록시 엔드포인트의 이름 (일반적으로 기본값)을 클릭합니다.
  2. 코드 편집기에서 <BasePath>를 원하는 이름으로 변경하여 <HttpProxyConnection> 요소를 수정합니다. 예를 들어 현재 <BasePath>가 v1/hello이고 이를 v1/my-node-file로 하고자 한다면 <BasePath> 요소를 다음과 같이 변경합니다.

    <BasePath>/v1/my-node-file</BasePath>
  3. 저장을 클릭합니다.
  4. 다음과 같은 새 기본 경로를 사용하여 프록시를 호출합니다.

    $ curl http://myorg-test.apigee.net/v1/my-node-file
    Hello, World!
    

Node.js 코드로 프록시 내보내기 및 가져오기

Node.js 코드가 포함된 프록시를 Edge에 배포한 후 언제든지 프록시를 시스템으로 다시 내보내고 시스템에서 작업한 다음 관리 UI를 사용하여 Edge로 다시 가져올 수 있습니다. 이러한 종류의 왕복 개발 기법이 일반적으로 사용됩니다.

  1. API 프록시 요약 페이지에서 개발을 클릭합니다.
  2. 개발 페이지에서 현재 버전 다운로드를 선택합니다.
  3. 다운로드한 파일의 압축을 시스템에 풉니다.

동일한 메뉴에서 새 버전으로 가져오기를 선택하여 프록시 번들을 Edge로 다시 가져올 수 있습니다.

API를 사용하여 프록시를 배포할 수도 있습니다. 자세한 내용은 명령줄에서 프록시 배포를 참조하세요.

다음 단계

다음 주제인 기존 API 프록시에 Node.js 추가에서는 파일 시스템의 기존 프록시에 Node.js 앱을 추가하고 Edge에 배포하는 방법을 설명합니다.