Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
In dieser Anleitung erstellen Sie eine OpenAPI-Spezifikation, um eine API zu modellieren, die einen Zielserver aufruft. Der Zielserver besteht aus einem sehr einfachen Node.js-basierten Server, den Sie auf Ihrem Computer erstellen und ausführen. Diese Anleitung dauert etwa 10 Minuten.
Lerninhalte
In dieser Anleitung erfahren Sie, wie Sie:
- Einfachen Node.js-Server erstellen
- Erstellen Sie eine OpenAPI-Spezifikation , mit der eine API modelliert wird, die den Node.js-Server aufruft.
Voraussetzungen
Dafür benötigen Sie Folgendes:
- Apigee Edge-Konto (siehe Apigee Edge-Konto erstellen)
- Aktuelle Version von Node.js
- curl-Befehlszeilentool
- Texteditor
Einfachen Node.js-Server erstellen
So erstellen Sie einen einfachen Node.js-Server:
- Erstellen Sie eine Datei mit dem Namen
index.js
. Kopieren Sie den folgenden Node.js-Code in die Datei:
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!'); });
Speichere die Datei.
Installieren Sie das erforderliche Express-Modul:
npm install express
Starten Sie den Server:
node index.js
Die folgende Meldung wird zurückgegeben:
Example app listening on port 3000
Testen Sie die API, indem Sie die folgende HTTP-Anfrage senden.
curl localhost:3000/v1/hello
Die API gibt Folgendes zurück: Hello World!
OpenAPI-Spezifikation erstellen
Sie erstellen eine OpenAPI-Spezifikation, die die API modelliert, die den Node.js-Server aufruft.
- Melden Sie sich unter apigee.com/edge an.
- Wählen Sie in der seitlichen Navigationsleiste Develop > Specs aus.
Die Liste der Spezifikationen wird angezeigt. Klicken Sie auf + Spec (+ Spezifikation) und wählen Sie im Drop-down-Menü New Spec (Neue Spezifikation) aus.
Kopieren Sie den folgenden YAML-Inhalt:
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
Fügen Sie den YAML-Inhalt im linken Bereich des Editors ein. Dabei wird der aktuelle Inhalt überschrieben.
Klicken Sie auf Speichern.
Sie werden aufgefordert, der Spezifikation einen Namen zu geben.Geben Sie einen Namen für die Spezifikation ein, z. B. simple-spec.
Klicken Sie auf Weiter.
Die Spezifikation wird gespeichert.Klicken Sie auf Schließen, um die Spezifikation zu schließen und zur Spezifikationsliste zurückzukehren.
Die neue Spezifikation wird in der Spezifikationsliste angezeigt.
Nächste Schritte
Glückwunsch! Sie haben Ihre erste OpenAPI-Spezifikation erstellt, um eine API zu modellieren, die einen Zielserver aufruft.
Erfahren Sie als Nächstes, wie Sie einen API-Proxy aus einer OpenAPI-Spezifikation erstellen.