Saat ini, sebagian besar API dibedakan berdasarkan method dan path. Namun, beberapa proyek pengembangan (seperti beberapa dokumen API e-commerce) menggunakan URL tetap untuk permintaan API dan membedakan API menggunakan parameter dalam Query / Header.Setelah versi 2.2.9, Apidog menambahkan fitur identifikasi unik endpoint, yang mendukung OperationId, parameter Query, parameter Body, dan parameter Header sebagai parameter untuk membedakan API.
ID unik endpoint ditentukan pada tingkat direktori. Ketika Anda perlu menetapkan API sebagai identifikasi unik, Anda perlu mengaturnya di direktori induknya. Klik direktori dan pilih parameter identifikasi unik sesuai kebutuhan Anda, lalu setelah mengklik simpan, pengaturan tersebut akan berlaku untuk semua API di bawah direktori tersebut.
Untuk contoh ini, kita akan memilih parameter Query dan menulis OperationID di dalam nama parameter.
Setelah mengatur identifikasi unik endpoint untuk direktori, klik API di bawah direktori tersebut, klik tab operationid, dan baik pada informasi dasar maupun parameter permintaan di bagian bawah API, terdapat ikon K, yang mewakili parameter untuk ID unik endpoint.
Anda dapat memasukkan nilai yang sesuai di bawah parameter terkait sebagai nilai untuk identifikasi unik endpoint.
Jika Anda menggunakan parameter dalam Query/Header untuk membedakan API dalam proyek Anda dan mengimpor file berformat OpenAPI ke Apidog, halaman berikut akan muncul.Aturan untuk mencocokkan API selama impor bergantung pada pengaturan direktori target. Jika pengaturan identifikasi unik endpoint dalam direktori target tidak memenuhi persyaratan, Anda dapat memodifikasinya dalam pengaturan impor. Setelah dimodifikasi, pengaturan tersebut akan langsung berlaku pada direktori target.Sebagai contoh, kita akan mengimpor direktori ini dan membuat ID unik endpoint untuknya dengan Query Param dan Param Name yang disebut action.
Ingat, jika direktori Anda sudah memiliki ID unik, impor baru tidak dapat menimpanya.
Catatan Penting
1.
Pengguna yang telah menggunakan Fixed Value dalam parameter Query tidak perlu khawatir karena fungsi ini masih akan tetap dipertahankan. Namun, saat mengimpor, Fixed Value dinilai berdasarkan URL, sehingga disarankan agar pengguna yang telah menggunakan Fixed Value menggunakan identifikasi unik endpoint.
2.
Identifikasi unik endpoint mendukung pengaturan beberapa parameter.
3.
Jika hanya subdirektori dalam direktori Anda yang ditetapkan sebagai identifikasi unik endpoint, saat mengimpor Swagger dan memperbarui semua direktori, harap hindari mengimpor semua proyek ke direktori root untuk pembaruan. Disarankan untuk mengimpor API yang ditetapkan sebagai identifikasi unik endpoint secara terpisah ke direktori khusus tersebut.
Mulai dari versi 2.2.24, jika API telah menetapkan pengidentifikasi unik sebagai Parameter Body atau Parameter Header, Anda perlu mengirim path + nama parameter dan nilai pengidentifikasi unik untuk mendapatkan Data Mock yang sesuai.
Praktik Terbaik Data Mock
1.
Saat mengakses Data Mock selama pengembangan, pengembang frontend juga perlu mengirim path + nama parameter dan nilai pengidentifikasi unik jika API telah menetapkan pengidentifikasi unik sebagai Parameter Body atau Parameter Header.
2.
Untuk proyek yang memiliki pengidentifikasi unik untuk API, dokumentasi API perlu distandardisasi untuk menghindari kasus ketika API memiliki URL yang sama tetapi tidak memiliki pengidentifikasi unik yang ditetapkan. Hal ini untuk menghindari kegagalan dalam memperoleh Data Mock dengan benar.
