Mengelola spesifikasi

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

Apigee Edge menyediakan tempat untuk menyimpan Spesifikasi OpenAPI Anda. Kelola Spesifikasi OpenAPI Anda, seperti yang dijelaskan di bagian berikut.

Untuk mengetahui informasi selengkapnya tentang Spesifikasi OpenAPI, lihat Apa yang dimaksud dengan Spesifikasi OpenAPI?

Menjelajahi daftar spesifikasi

Untuk mengakses daftar spesifikasi:

1. Login ke apigee.com/edge.
2. Pilih organisasi.
3. Pilih Develop > Specs di menu navigasi samping.

Daftar spesifikasi dan folder saat ini akan ditampilkan.

Seperti yang ditunjukkan pada gambar sebelumnya, dari daftar spesifikasi, Anda dapat:

• Spesifikasi pembuatan dan pengimporan
• Membuat proxy API dari spesifikasi menggunakan wizard multi-langkah
• Atur spesifikasi Anda menggunakan folder dan jelajahi folder tersebut (lihat Mengatur konten menggunakan folder)
• Edit spesifikasi atau buka folder dengan mengklik baris
• Mengganti nama atau menghapus spesifikasi
• Menelusuri daftar spesifikasi dan folder

Membuat Spesifikasi OpenAPI baru

Untuk membuat Spesifikasi OpenAPI baru:

1. Klik Develop > Specs di menu navigasi samping.
2. Klik + Spec.
3. Klik Spesifikasi Baru di menu drop-down. Editor spesifikasi akan terbuka.
4. Ganti spesifikasi contoh dengan detail Spesifikasi OpenAPI Anda sendiri.
   Lihat Membuat spesifikasi menggunakan editor spesifikasi.
5. Klik Simpan untuk menyimpan spesifikasi.
6. Masukkan nama untuk spesifikasi saat diminta.
7. Klik Simpan.

Mengimpor Spesifikasi OpenAPI

Untuk mengimpor Spesifikasi OpenAPI:

1. Klik Develop > Specs di menu navigasi samping.
2. Klik + Spec.
3. Klik salah satu opsi berikut dari menu drop-down:
   • Impor URL untuk mengimpor spesifikasi dari URL. Tentukan nama dan URL saat diminta.
   • Impor file untuk menjelajahi direktori lokal Anda guna menemukan spesifikasi.
     Spesifikasi ditambahkan ke daftar.
4. Klik nama spesifikasi untuk melihat dan mengeditnya di editor spesifikasi.
   Lihat Membuat spesifikasi menggunakan editor spesifikasi.

Mengedit Spesifikasi OpenAPI yang ada

Untuk membuka Spesifikasi OpenAPI yang ada:

1. Klik Develop > Specs di menu navigasi samping.
2. Klik baris yang terkait dengan spesifikasi dalam daftar spesifikasi.
3. Edit spesifikasi di editor spesifikasi.
   Lihat Membuat spesifikasi menggunakan editor spesifikasi.

Membuat proxy API dari spesifikasi dalam daftar spesifikasi

Dengan Apigee Edge, Anda dapat membuat proxy API dari Spesifikasi OpenAPI yang Anda desain dan simpan di editor spesifikasi. Hanya dengan beberapa klik, Anda akan memiliki proxy API di Apigee Edge dengan jalur, parameter, alur bersyarat, dan endpoint target yang dibuat secara otomatis. Kemudian, Anda dapat menambahkan fitur seperti keamanan OAuth, pembatasan kapasitas, dan caching.

Setelah membuat proxy API dari Spesifikasi OpenAPI, jika spesifikasi diubah, Anda harus mengubah proxy API secara manual untuk mencerminkan perubahan yang diterapkan. Lihat Apa yang terjadi jika saya mengubah spesifikasi?.

Untuk membuat proxy API dari Spesifikasi OpenAPI dalam daftar spesifikasi:

1. Pilih Develop > Specs di menu navigasi samping.
2. Buka folder yang berisi Spesifikasi OpenAPI, jika diperlukan.
3. Posisikan kursor Anda pada Spesifikasi OpenAPI yang ingin Anda buat proxy API-nya untuk menampilkan menu tindakan.
4. Klik . Wizard Create Proxy akan terbuka dan halaman detail Proxy akan diisi otomatis menggunakan nilai dari Spesifikasi OpenAPI, seperti yang ditunjukkan pada gambar berikut.
   
5. Klik Berikutnya.
6. Lanjutkan langkah-langkah di halaman yang tersisa dalam wizard Create Proxy, seperti yang dijelaskan dalam Membuat proxy API dari Spesifikasi OpenAPI. (Mulai dari langkah 8.)

Mengganti nama spesifikasi

Untuk mengganti nama spesifikasi:

1. Pilih Develop > Specs di menu navigasi samping.
2. Buka folder yang berisi spesifikasi, jika diperlukan.
3. Posisikan kursor di atas spesifikasi yang ingin Anda ganti namanya untuk menampilkan menu tindakan.
4. Klik .
5. Edit nama spesifikasi.
6. Klik Ganti nama untuk menyimpan hasil edit atau Batal untuk membatalkan.

Memindahkan spesifikasi ke folder

Anda dapat mengatur spesifikasi ke dalam folder untuk mempermudah pengelolaan dan keamanan. Untuk memindahkan spesifikasi ke dalam folder, lihat Mengatur spesifikasi menggunakan folder.

Menghapus spesifikasi

Anda dapat menghapus spesifikasi dari penyimpanan file jika tidak lagi diperlukan atau menjadi tidak valid.

Untuk menghapus spesifikasi:

1. Pilih Develop > Specs di menu navigasi samping.
2. Posisikan kursor di atas spesifikasi yang ingin Anda hapus untuk menampilkan menu tindakan.
3. Klik .
4. Klik Hapus untuk mengonfirmasi operasi penghapusan saat diminta.
5. Hapus artefak terkait yang tidak lagi diperlukan.