Membuat Spesifikasi OpenAPI

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Dalam tutorial ini, Anda akan membuat Spesifikasi OpenAPI untuk memodelkan API yang memanggil server target. Server target terdiri dari server berbasis Node.js yang sangat sederhana yang Anda buat dan jalankan di komputer Anda. Tutorial ini membutuhkan waktu sekitar 10 menit untuk diselesaikan.

Yang akan Anda pelajari

Dalam tutorial ini, Anda akan mempelajari cara:

Yang Anda butuhkan

Berikut hal-hal yang Anda perlukan untuk memulai:

Membuat server Node.js sederhana

Untuk membuat server Node.js sederhana:

  1. Buat file dengan nama index.js.

  2. Salin kode Node.js berikut ke dalam 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. Simpan file.

  4. Instal modul Express yang diperlukan:

    npm install express

  5. Mulai server:

    node index.js

    Pesan berikut akan ditampilkan:
    Example app listening on port 3000

  6. Uji API dengan mengirim permintaan HTTP berikut. 

    curl localhost:3000/v1/hello

    API akan menampilkan: Halo Dunia!

Membuat Spesifikasi OpenAPI

Untuk membuat Spesifikasi OpenAPI yang memodelkan API yang memanggil server Node.js.

  1. Login ke apigee.com/edge.
  2. Pilih Develop > Specs di menu navigasi samping.
    Daftar spesifikasi akan ditampilkan.

  3. Klik + Spec dan pilih New Spec di menu drop-down.

  4. Salin konten YAML berikut: 

    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. Tempel konten YAML ke panel kiri editor (menimpa konten saat ini).

  6. Klik Simpan.
    Anda akan diminta untuk memberi nama spesifikasi.

  7. Masukkan nama untuk spesifikasi, seperti: simple-spec.

  8. Klik Lanjutkan.
    Spesifikasi disimpan.

  9. Klik Tutup untuk menutup spesifikasi dan kembali ke daftar spesifikasi.

Spesifikasi baru akan ditampilkan dalam daftar spesifikasi.

Apa Langkah Selanjutnya?

Selamat! Anda telah membuat Spesifikasi OpenAPI pertama untuk memodelkan API yang memanggil server target.

Selanjutnya, pelajari cara membuat proxy API dari Spesifikasi OpenAPI.