Créer une spécification OpenAPI

Vous consultez la documentation Apigee Edge.
Accédez à la documentation sur Apigee X. info

Dans ce tutoriel, vous allez créer une spécification OpenAPI pour modéliser une API qui appelle un serveur cible. Le serveur cible est un serveur très simple basé sur Node.js, que vous créez et exécutez sur votre machine. Ce tutoriel prend environ 10 minutes.

Points abordés

Dans ce tutoriel, vous allez apprendre à:

• Créer un serveur Node.js simple
• Créer une spécification OpenAPI qui modélise une API qui appelle le serveur Node.js

Prérequis

Voici ce dont vous avez besoin pour commencer:

• Compte Apigee Edge (consultez Créer un compte Apigee Edge)
• Version récente de Node.js
• Outil de ligne de commande curl
• Éditeur de texte

Créer un serveur Node.js simple

Pour créer un serveur Node.js simple:

1. Créez un fichier appelé index.js :

2. Copiez le code Node.js suivant dans le fichier:

   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. Enregistrez le fichier.

4. Installez le module Express requis:

   npm install express

5. Démarrez le serveur :

   node index.js

   Le message suivant est renvoyé:
   Example app listening on port 3000

6. Testez l'API en envoyant la requête HTTP suivante.

   curl localhost:3000/v1/hello

   L'API renvoie: Hello World!

Créer une spécification OpenAPI

Créer une spécification OpenAPI qui modélise l'API qui appelle le serveur Node.js

1. Connectez-vous à apigee.com/edge.
2. Sélectionnez Développer > Spécifications dans la barre de navigation latérale.
   La liste des spécifications s'affiche.

3. Cliquez sur + Spécification et sélectionnez Nouvelle spécification dans le menu déroulant.

4. Copiez le contenu YAML suivant:

   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. Collez le contenu YAML dans le volet de gauche de l'éditeur (en écrasant le contenu actuel).

6. Cliquez sur Enregistrer.
   Vous êtes invité à nommer la spécification.

7. Saisissez un nom pour la spécification, par exemple simple-spec.

8. Cliquez sur Continuer.
   La spécification est enregistrée.

9. Cliquez sur Fermer pour fermer la spécification et revenir à la liste des spécifications.

La nouvelle spécification s'affiche dans la liste des spécifications.

Et maintenant ?

Félicitations ! Vous avez créé votre première spécification OpenAPI pour modéliser une API qui appelle un serveur cible.

Découvrez ensuite comment créer un proxy d'API à partir d'une spécification OpenAPI.