OpenAPI 사양 만들기

현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서로 이동 정보

이 튜토리얼에서는 OpenAPI 사양을 만들어 대상 서버를 호출하는 API를 모델링합니다. 타겟 서버는 머신에서 만들고 실행하는 매우 간단한 Node.js 기반 서버로 구성됩니다. 이 튜토리얼을 완료하는 데 10분 정도 걸립니다.

학습할 내용

이 튜토리얼에서는 다음을 수행하는 방법을 알아봅니다.

필요한 항목

시작하려면 다음이 필요합니다.

간단한 Node.js 서버 만들기

간단한 Node.js 서버를 만들려면 다음 단계를 따르세요.

  1. index.js라는 파일을 만듭니다.

  2. 다음 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!');
});

  3. 파일을 저장합니다.

  4. 필요한 Express 모듈을 설치합니다.

    npm install express

  5. 서버를 시작합니다.

    node index.js

    다음 메시지가 반환됩니다.
    Example app listening on port 3000

  6. 다음 HTTP 요청을 전송하여 API를 테스트합니다. 

    curl localhost:3000/v1/hello

    API가 Hello World!를 반환합니다.

OpenAPI 사양 만들기

Node.js 서버를 호출하는 API를 모델링하는 OpenAPI 사양을 만듭니다.

  1. apigee.com/edge에 로그인합니다.
  2. 측면 탐색 메뉴에서 Develop(개발) > Specs(사양)를 선택합니다.
    spec 목록이 표시됩니다.

  3. 드롭다운 메뉴에서 + Spec(+ 사양)을 클릭하고 New Spec(새 사양)을 선택합니다.

  4. 다음 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

  5. YAML 콘텐츠를 편집기의 왼쪽 창에 붙여넣습니다 (현재 콘텐츠를 덮어쓰기).

  6. 저장을 클릭합니다.
    사양 이름을 지정하라는 메시지가 표시됩니다.

  7. 사양의 이름을 입력합니다(예: simple-spec).

  8. 계속을 클릭합니다.
    사양이 저장됩니다.

  9. 닫기를 클릭하여 사양을 닫고 사양 목록으로 돌아갑니다.

새 사양이 사양 목록에 표시됩니다.

다음 단계

축하합니다. 대상 서버를 호출하는 API를 모델링하는 첫 번째 OpenAPI 사양을 만들었습니다.

다음으로 OpenAPI 사양에서 API 프록시를 만드는 방법을 알아봅니다.