Crea una specifica OpenAPI

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info

In questo tutorial creerai una specifica OpenAPI per modellare un'API che chiama un server di destinazione. Il server di destinazione è costituito da un semplice server basato su Node.js, che puoi creare ed eseguire sulla tua macchina. Il completamento di questo tutorial richiede circa 10 minuti.

Obiettivi didattici

In questo tutorial imparerai a:

Che cosa ti serve

Ecco cosa ti serve per iniziare:

Creare un semplice server Node.js

Per creare un semplice server Node.js:

  1. Crea un file denominato index.js.

  2. Copia il seguente codice Node.js nel file:

    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. Salva il file.

  4. Installa il modulo Express richiesto:

    npm install express

  5. Avvia il server:

    node index.js

    Viene restituito il seguente messaggio:
    Example app listening on port 3000

  6. Testa l'API inviando la seguente richiesta HTTP. 

    curl localhost:3000/v1/hello

    L'API restituisce: Hello World!

Crea una specifica OpenAPI

Creare una specifica OpenAPI che modella l'API che chiama il server Node.js.

  1. Accedi ad apigee.com/edge.
  2. Seleziona Sviluppo > Specifiche nella barra di navigazione laterale.
    Viene visualizzato l'elenco delle specifiche.

  3. Fai clic su + Specifica e seleziona Nuova specifica nel menu a discesa.

  4. Copia il seguente contenuto 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. Incolla i contenuti YAML nel riquadro a sinistra dell'editor (sovrascrivendo i contenuti correnti).

  6. Fai clic su Salva.
    Ti viene chiesto di assegnare un nome alla specifica.

  7. Inserisci un nome per la specifica, ad esempio simple-spec.

  8. Fai clic su Continua.
    La specifica viene salvata.

  9. Fai clic su Chiudi per chiudere la specifica e tornare all'elenco delle specifiche.

La nuova specifica viene visualizzata nell'elenco delle specifiche.

Passaggi successivi

Complimenti! Hai creato la tua prima specifica OpenAPI per modellare un'API che chiama un server di destinazione.

A questo punto, scopri come creare un proxy API da una specifica OpenAPI.