Tworzenie specyfikacji OpenAPI

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

W tym samouczku tworzysz specyfikację OpenAPI, aby modelować interfejs API, który wywołuje serwer docelowy. Serwer docelowy składa się z bardzo prostego serwera opartego na Node.js, który musisz utworzyć i uruchomić na swoim komputerze. Ukończenie tego samouczka zajmuje około 10 minut.

Czego się nauczysz

Z tego samouczka dowiesz się, jak:

Czego potrzebujesz

Aby rozpocząć, wykonaj następujące czynności:

Tworzenie prostego serwera Node.js

Aby utworzyć prosty serwer Node.js:

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

  2. Skopiuj do tego 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 ta wiadomość:
    Example app listening on port 3000

  6. Przetestuj interfejs API, wysyłając to żądanie HTTP. 

    curl localhost:3000/v1/hello

    Interfejs API zwraca: Hello World!

Tworzenie specyfikacji OpenAPI

Aby utworzyć specyfikację OpenAPI modelującą interfejs API wywołujący serwer Node.js.

  1. Zaloguj się na stronie apigee.com/edge.
  2. Na bocznym pasku nawigacyjnym wybierz Programowanie > Specyfikacje.
    Wyświetli się lista specyfikacji.

  3. Kliknij + Specyfikacja i w menu wybierz Nowa specyfikacja.

  4. Skopiuj tę treść 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ąpienie bieżącej treści).

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

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

  8. Kliknij Dalej.
    Specyfikacja zostanie zapisana.

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

Nowa specyfikacja jest wyświetlana na liście specyfikacji.

Co dalej?

Gratulacje! Udało Ci się utworzyć pierwszą specyfikację OpenAPI, która służy do modelowania interfejsu API, który wywołuje serwer docelowy.

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