Как создать спецификацию OpenAPI

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

В этом руководстве вы создадите спецификацию 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. Нажмите + Спецификация и выберите Новая спецификация в раскрывающемся меню.

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.