Membuat spesifikasi menggunakan editor spesifikasi

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

Buat dan validasi Spesifikasi OpenAPI tanpa menulis kode apa pun menggunakan editor spesifikasi.

Mengakses editor spesifikasi

Buka Spesifikasi OpenAPI di editor spesifikasi, seperti yang dijelaskan di bagian berikut:

Gambar berikut menunjukkan spesifikasi untuk Petstore API yang terbuka di editor spesifikasi:

Seperti yang ditandai pada gambar sebelumnya, editor spesifikasi memungkinkan Anda untuk:

  • Buat Spesifikasi OpenAPI untuk membuat model API menggunakan format JSON atau YAML di panel kiri.
  • Lihat dokumentasi API yang dibuat otomatis di panel kanan.
  • Validasi spesifikasi Anda terhadap standar Spesifikasi OpenAPI, saat Anda mengetik.
  • Simpan Spesifikasi OpenAPI atau tutup spesifikasi dan batalkan hasil edit Anda.

Bantu saya menggunakan JSON dan YAML

JSON (JavaScript Object Notation) adalah format pertukaran data ringan yang digunakan untuk merepresentasikan struktur data sederhana dan array asosiatif. Untuk mempelajari lebih lanjut, lihat https://www.json.org.

YAML (YAML Ain't Markup Language) adalah standar serialisasi/representasi data yang menyediakan sintaksis yang juga menyediakan sintaksis yang dapat dipetakan ke struktur data, seperti daftar, array asosiatif, dan skalar. Untuk mempelajari lebih lanjut, lihat https://yaml.org.

JSON dan YAML dapat dibaca mesin, tetapi juga mudah dibaca dan dipahami oleh manusia. Gambar berikut membandingkan dua kutipan singkat dari Spesifikasi OpenAPI yang sama yang ditulis menggunakan JSON dan YAML:

JSON versus YAML

Memvalidasi spesifikasi

Editor spesifikasi memvalidasi Spesifikasi OpenAPI Anda berdasarkan standar Spesifikasi OpenAPI. Saat Anda mengetik, jika ada error dalam Spesifikasi OpenAPI, editor spesifikasi akan menampilkan dialog Error di bagian atas panel kanan dan memberikan informasi selengkapnya tentang error dan nomor barisnya yang terkait sehingga Anda dapat dengan mudah memperbaikinya.

Error

Menyimpan spesifikasi

Untuk menyimpan Spesifikasi OpenAPI, klik Simpan di menu navigasi atas.

Jika ini pertama kalinya Anda menyimpan spesifikasi, Anda akan diminta untuk memasukkan nama file. Jika Anda tidak menentukan nama file, nama file defaultnya adalah Tanpa Judul. Anda dapat mengganti namanya nanti.

Menutup spesifikasi

Untuk menutup Spesifikasi OpenAPI tanpa menyimpan hasil edit, klik Batal di menu navigasi atas. Anda akan kembali ke daftar spesifikasi.