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 itu Spesifikasi OpenAPI?

Lihat 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 disorot dalam gambar sebelumnya, dari daftar spesifikasi, Anda dapat:

• Membuat dan import spesifikasi
• Membuat proxy API dari spesifikasi menggunakan wizard multi-langkah
• Atur spesifikasi Anda menggunakan folder dan lihat beberapa folder tersebut (lihat Mengatur konten menggunakan folder)
• Edit spesifikasi atau membuka folder dengan mengklik baris
• Mengganti nama atau menghapus spesifikasi
• Telusuri daftar spesifikasi dan folder

Membuat Spesifikasi OpenAPI baru

Untuk membuat Spesifikasi OpenAPI baru:

1. Klik Develop > Specs di menu navigasi samping.
2. Klik + Spesifikasi.
3. Klik Spesifikasi Baru di menu drop-down. Editor spesifikasi akan terbuka.
4. Ganti contoh spesifikasi dengan detail Spesifikasi OpenAPI Anda sendiri.
   Lihat Membuat spesifikasi menggunakan editor spesifikasi.
5. Klik Save 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 + Spesifikasi.
3. Klik salah satu opsi berikut dari menu drop-down:
   • Impor URL untuk mengimpor spesifikasi dari URL. Tentukan nama dan URL jika diminta.
   • Impor file untuk menjelajahi direktori lokal untuk mengetahui spesifikasinya.
     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, flow kondisional, dan endpoint target yang dihasilkan secara otomatis. Kemudian, Anda dapat menambahkan fitur seperti keamanan OAuth, pembatasan kapasitas, dan cache.

Setelah membuat proxy API dari Spesifikasi OpenAPI, jika spesifikasi dimodifikasi, Anda perlu memodifikasi proxy API secara manual untuk mencerminkan perubahan yang diimplementasikan. 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 di Spesifikasi OpenAPI yang proxy API-nya ingin Anda buat untuk menampilkan menu tindakan.
4. Klik . Wizard Create Proxy terbuka dan halaman detail Proxy sudah diisi sebelumnya menggunakan nilai dari OpenAPI Specification, seperti yang ditampilkan dalam gambar berikut.
   
5. Klik Next.
6. Telusuri halaman yang tersisa di 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. Arahkan kursor ke spesifikasi yang ingin diganti 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 menyusun spesifikasi ke dalam folder untuk memfasilitasi pengelolaan dan keamanan. Untuk memindahkan spesifikasi ke dalam folder, lihat Mengatur spesifikasi menggunakan folder.

Menghapus spesifikasi

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

Untuk menghapus spesifikasi:

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