현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보
이 튜토리얼에서는 OpenAPI 사양을 만들어 대상 서버를 호출하는 API를 모델링합니다. 대상 서버는 사용자가 머신에서 만들고 실행하는 매우 간단한 Node.js 기반 서버로 구성됩니다. 이 가이드는 완료하는 데 10분 정도 걸립니다.
학습할 내용
이 튜토리얼에서는 다음 방법을 알아봅니다.
- 간단한 Node.js 서버 만들기
- Node.js 서버를 호출하는 API를 모델링하는 OpenAPI 사양 만들기
필요한 항목
시작하는 데 필요한 사항은 다음과 같습니다.
- Apigee Edge 계정 (Apigee Edge 계정 만들기 참조)
- 최신 버전의 Node.js
- curl 명령줄 도구
- 텍스트 편집기
간단한 Node.js 서버 만들기
간단한 Node.js 서버를 만들려면 다음 안내를 따르세요.
index.js
라는 파일을 만듭니다.다음 Node.js 코드를 파일에 복사합니다.
var express = require('express'); var app = express(); app.get('/v1/hello', function (req, res) { res.setHeader("Access-Control-Allow-Origin", "*"); res.send('Hello World!\n'); }); app.listen(3000, function () { console.log('Example app listening on port 3000!'); });
파일을 저장합니다.
필수 Express 모듈을 설치합니다.
npm install express
서버를 시작합니다.
node index.js
다음 메시지가 반환됩니다.
Example app listening on port 3000
다음 HTTP 요청을 전송하여 API를 테스트합니다.
curl localhost:3000/v1/hello
API에서 다음을 반환합니다. Hello World!
OpenAPI 사양 만들기
Node.js 서버를 호출하는 API를 모델링하는 OpenAPI 사양을 만들기 위해
- apigee.com/edge에 로그인합니다.
- 측면 탐색 메뉴에서 개발 > 사양을 선택합니다.
사양 목록이 표시됩니다. + 사양을 클릭하고 드롭다운 메뉴에서 새 사양을 선택합니다.
다음 YAML 콘텐츠를 복사합니다.
swagger: "2.0" info: version: "0.0.1" title: Hello World API host: 127.0.0.1:3000 basePath: /v1 schemes: - http consumes: - application/json produces: - application/json paths: '/hello': get: description: Returns greetings to the caller operationId: hello responses: "200": description: Success schema: $ref: "#/definitions/HelloWorldResponse" default: description: Error schema: $ref: "#/definitions/ErrorResponse" definitions: HelloWorldResponse: required: - message properties: message: type: string age: type: number ErrorResponse: required: - message properties: message: type: string
YAML 콘텐츠를 편집기의 왼쪽 창에 붙여넣습니다 (현재 콘텐츠 덮어쓰기).
저장을 클릭합니다.
사양 이름을 지정하라는 메시지가 표시됩니다.사양의 이름을 입력합니다(예: simple-spec).
계속을 클릭합니다.
사양이 저장됩니다.닫기를 클릭하여 사양을 닫고 사양 목록으로 돌아갑니다.
새로운 사양이 사양 목록에 표시됩니다.
다음 단계
수고하셨습니다 대상 서버를 호출하는 API를 모델링하기 위한 첫 번째 OpenAPI 사양을 만들었습니다.
다음으로 OpenAPI 사양에서 API 프록시를 만드는 방법을 알아보세요.