Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Dalam tutorial ini, Anda akan membuat Spesifikasi OpenAPI untuk membuat model API yang memanggil server target. Server target terdiri dari server berbasis Node.js yang sangat sederhana yang Anda buat dan jalankan di komputer. Perlu waktu sekitar 10 menit untuk menyelesaikan tutorial ini.
Yang akan Anda pelajari
Dalam tutorial ini, Anda akan mempelajari cara:
- Membuat server Node.js sederhana
- Buat Spesifikasi OpenAPI yang memodelkan API yang memanggil server Node.js
Yang akan Anda butuhkan
Berikut yang Anda perlukan untuk memulainya:
- Akun Apigee Edge (lihat Membuat akun Apigee Edge)
- Versi terbaru Node.js
- Alat command line curl
- Editor teks
Membuat server Node.js sederhana
Untuk membuat server Node.js sederhana:
- Buat file dengan nama
index.js
. 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!'); });
Simpan file.
Instal modul Express yang diperlukan:
npm install express
Mulai server:
node index.js
Pesan berikut ditampilkan:
Example app listening on port 3000
Uji API dengan mengirimkan permintaan HTTP berikut.
curl localhost:3000/v1/hello
API akan menampilkan: Hello World!
Membuat Spesifikasi OpenAPI
Untuk membuat Spesifikasi OpenAPI yang memodelkan API yang memanggil server Node.js.
- Login ke apigee.com/edge.
- Pilih Develop > Specs di menu navigasi samping.
Daftar spesifikasi akan ditampilkan. Klik + Spesifikasi dan pilih Spesifikasi Baru di menu drop-down.
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
Tempel konten YAML ke panel kiri editor (timpa konten saat ini).
Klik Simpan.
Anda akan diminta untuk memberi nama spesifikasi.Masukkan nama untuk spesifikasi, seperti: simple-spec.
Klik Continue.
Spesifikasi disimpan.Klik Close untuk menutup spesifikasi dan membuka kembali daftar spesifikasi.
Spesifikasi baru akan ditampilkan di daftar spesifikasi.
Apa Selanjutnya?
Selamat! Anda telah membuat Spesifikasi OpenAPI pertama untuk membuat model API yang memanggil server target.
Selanjutnya, pelajari cara membuat proxy API dari Spesifikasi OpenAPI.