Crea una especificación de OpenAPI

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

En este instructivo, crearás una especificación de OpenAPI para modelar una API que llame a un servidor de destino. El servidor de destino consiste en un servidor muy simple basado en Node.js que creas y ejecutas en tu máquina. Tardarás unos 10 minutos en completar este instructivo.

Qué aprenderás

En este instructivo, aprenderás a hacer lo siguiente:

• Crea un servidor Node.js simple
• Crea una especificación de OpenAPI que modele una API que llame al servidor de Node.js.

Requisitos

Para comenzar, necesitarás lo siguiente:

• Cuenta de Apigee Edge (consulta Crea una cuenta de Apigee Edge)
• Una versión reciente de Node.js
• Herramienta de línea de comandos curl
• Editor de texto

Crea un servidor Node.js simple

Para crear un servidor Node.js simple, sigue estos pasos:

1. Crea un archivo llamado index.js.

2. Copia el siguiente código de Node.js en el archivo:

   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. Guarda el archivo.

4. Instala el módulo Express requerido:

   npm install express

5. Inicia el servidor. Para esto, sigue los pasos siguientes:

   node index.js

   Se muestra el siguiente mensaje:
   Example app listening on port 3000

6. Para probar la API, envía la siguiente solicitud HTTP.

   curl localhost:3000/v1/hello

   La API muestra lo siguiente: Hello World!

Crea una especificación de OpenAPI

Crear una especificación de OpenAPI que modele la API que llama al servidor de Node.js

1. Accede a apigee.com/edge.
2. Selecciona Desarrollar > Especificaciones en la barra de navegación lateral.
   Se muestra la lista de especificaciones.

3. Haz clic en + Especificación y selecciona Especificación nueva en el menú desplegable.

4. Copia el siguiente contenido de 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. Pega el contenido de YAML en el panel izquierdo del editor (reemplazando el contenido actual).

6. Haz clic en Guardar.
   Se te solicitará que asignes un nombre a la especificación.

7. Ingresa un nombre para la especificación, como especificación-simple.

8. Haz clic en Continuar.
   Se guarda la especificación.

9. Haz clic en Cerrar para cerrar la especificación y volver a la lista de especificaciones.

La nueva especificación se muestra en la lista de especificaciones.

¿Qué sigue?

¡Felicitaciones! Creaste tu primera especificación de OpenAPI para modelar una API que llama a un servidor de destino.

A continuación, aprende a crear un proxy de API a partir de una especificación de OpenAPI.