Tworzenie specyfikacji OpenAPI

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

W tym samouczku utworzysz specyfikację OpenAPI, aby zamodelować interfejs API, który wywołuje serwer docelowy. Serwer docelowy to bardzo prosty serwer oparty na Node.js, który tworzysz i uruchamiasz na swoim komputerze. Przejście tego samouczka zajmie około 10 minut.

Czego się nauczysz

Z tego samouczka dowiesz się, jak:

• Tworzenie prostego serwera Node.js
• Utwórz specyfikację OpenAPI , która modeluje interfejs API wywołujący serwer Node.js.

Czego potrzebujesz

Oto czego potrzebujesz na początek:

• Konto Apigee Edge (zobacz Tworzenie konta Apigee Edge)
• Najnowsza wersja Node.js
• narzędzie wiersza poleceń curl,
• Edytor tekstu

Tworzenie prostego serwera Node.js

Aby utworzyć prosty serwer Node.js:

1. Utwórz plik o nazwie index.js.

2. Skopiuj do pliku ten kod 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. Zapisz plik.

4. Zainstaluj wymagany moduł Express:

   npm install express

5. Uruchom serwer:

   node index.js

   Zwracana jest następująca wiadomość:
   Example app listening on port 3000

6. Aby przetestować interfejs API, wyślij to żądanie HTTP.

   curl localhost:3000/v1/hello

   Interfejs API zwraca komunikat: Hello, World!.

Tworzenie specyfikacji OpenAPI

Aby utworzyć specyfikację OpenAPI, która modeluje interfejs API wywołujący serwer Node.js.

1. Zaloguj się na stronie apigee.com/edge.
2. Na pasku nawigacyjnym po lewej stronie kliknij Opracowywanie > Specyfikacje.
   Wyświetli się lista specyfikacji.

3. Kliknij + Spec i w menu kliknij Nowy specyfikacja.

4. Skopiuj ten plik 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. Wklej treść YAML w lewym panelu edytora (zastępując bieżącą zawartość).

6. Kliknij Zapisz.
   Pojawi się prośba o nazwanie specyfikacji.

7. Wpisz nazwę specyfikacji, np. simple-spec.

8. Kliknij Dalej.
   Specyfikacja została zapisana.

9. Aby zamknąć specyfikację i wrócić do listy specyfikacji, kliknij Zamknij.

Nowa specyfikacja pojawi się na liście specyfikacji.

Co dalej?

Gratulacje! Utworzono pierwszą specyfikację OpenAPI, aby zamodelować interfejs API, który wywołuje serwer docelowy.

Następnie dowiedz się, jak utworzyć serwer proxy interfejsu API na podstawie specyfikacji OpenAPI.