Создайте спецификацию OpenAPI

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

В этом руководстве вы создадите спецификацию OpenAPI для моделирования API, который обращается к целевому серверу. Целевой сервер представляет собой очень простой сервер на основе Node.js, который вы создадите и запустите на своем компьютере. Выполнение этого руководства займет около 10 минут.

Что вы узнаете

В этом уроке вы узнаете, как:

• Создайте простой сервер Node.js.
• Создайте спецификацию OpenAPI , которая моделирует API, обращающийся к серверу Node.js.

Что вам понадобится

Вот что вам понадобится для начала:

• Учетная запись Apigee Edge (см. Создание учетной записи Apigee Edge )
• Последняя версия Node.js
• инструмент командной строки curl
• Текстовый редактор

Создайте простой сервер 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. Протестируйте API, отправив следующий HTTP-запрос.

   curl localhost:3000/v1/hello

   API возвращает: Hello World!

Создайте спецификацию OpenAPI.

Цель — создать спецификацию OpenAPI, которая моделирует API, вызывающий сервер Node.js.

1. Войдите на сайт apigee.com/edge .
2. В боковой панели навигации выберите «Разработка» > «Характеристики» .
   Отображается список технических характеристик.

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. Нажмите «Закрыть» , чтобы закрыть спецификацию и вернуться к списку спецификаций.

Новые технические характеристики отображаются в списке технических характеристик.

Что дальше?

Поздравляем! Вы создали свою первую спецификацию OpenAPI для моделирования API, который обращается к целевому серверу.

Далее вы узнаете, как создать API-прокси на основе спецификации OpenAPI .