Artikel ini memperkenalkan konsep inti di Apidog, sebuah alat API-first yang dirancang untuk desain API, pengujian, dan kolaborasi yang efisien. Banyak konsep berbeda dari produk serupa seperti Postman. Memahami konsep-konsep ini akan membantu Anda menavigasi alur kerja Apidog secara efektif.Proyek#
Proyek di Apidog adalah unit utama kolaborasi, yang berisi modul, lingkungan, skenario pengujian, dan lainnya. Proyek berfungsi sebagai wadah untuk semua pekerjaan terkait API dalam sebuah tim.Komponen Utama Proyek#
Modul: Pengelompokan logis endpoint dan komponen terkait.
Lingkungan: Kumpulan variabel untuk berbagai tahap deployment (misalnya, development, staging, production).
Skenario Pengujian: Kumpulan permintaan untuk pengujian otomatis.
Spesifikasi Endpoint: Dokumentasi API berdasarkan standar OpenAPI/Swagger.
Perbandingan dengan Postman#
| Konsep Apidog | Padanan di Postman | Deskripsi |
|---|
| Proyek | Workspace | Unit organisasi tingkat atas untuk kolaborasi. |
| Modul | Collection Folder | Mengelompokkan endpoint terkait. |
| Tim | Team | Fitur akses bersama dan kolaborasi. |
Proyek memungkinkan kolaborasi yang lancar, sehingga beberapa pengguna dapat bekerja pada API secara bersamaan sambil mempertahankan kontrol versi dan izin akses.
Modul#
Modul mengorganisasi endpoint secara logis dalam sebuah proyek, mirip dengan "service" dalam arsitektur microservices. Setiap modul mewakili file spesifikasi OpenAPI mandiri.Fitur Modul#
Berisi endpoint, schema, respons, dan skema keamanan terkait.
Dikonfigurasi dengan Base URL per lingkungan untuk pembuatan URL otomatis.
Mendukung operasi impor/ekspor pada tingkat modul untuk kepatuhan standar yang lebih baik.
Kapan Menggunakan Modul#
Untuk microservices: Setiap service sebagai modul terpisah.
Untuk beberapa API: Kelompokkan endpoint berdasarkan fungsionalitas atau domain.
Default: Proyek baru dimulai dengan satu modul; tambahkan lebih banyak sesuai kebutuhan untuk beberapa base URL.
Modul selaras dengan OpenAPI Specification (OAS), sehingga memfasilitasi integrasi dengan alat lain dan mempertahankan batas API yang rapi.
Endpoint#
Endpoint adalah elemen inti dalam pendekatan API-first Apidog, yang mewakili operasi API tertentu (misalnya, GET /users/{id}).Manajemen Endpoint#
Dikelompokkan dalam struktur direktori untuk pengorganisasian.
Ditautkan ke kasus endpoint untuk contoh permintaan yang disimpan.
Perbedaan dari Postman#
| Aspek | Apidog (Berbasis Endpoint) | Postman (Berbasis Permintaan) |
|---|
| Unit Dasar | Endpoint (spesifikasi API) | Permintaan (pemanggilan individual) |
| Perubahan Spesifikasi | Memperbarui kasus dan pengujian secara otomatis | Perlu penulisan ulang manual |
| Struktur | Ekstensi OAS dengan debugging | Spesifikasi dan permintaan terpisah |
Di Apidog, perubahan pada spesifikasi endpoint secara otomatis disebarkan ke semua kasus dependen, sehingga mengurangi beban pemeliharaan melalui pendekatan berbasis spesifikasi ini.
Lingkungan#
Lingkungan mengelola variabel dan base URL untuk berbagai konteks deployment, sehingga memungkinkan peralihan yang lancar antara dev, staging, dan production.Fitur Utama#
Berisi variabel lingkungan untuk nilai dinamis.
Mendukung beberapa Base URL per lingkungan untuk microservices. Konstruksi URL otomatis: Base URL + Jalur Endpoint.
Contoh Base URL#
Misalkan sebuah proyek dengan tiga service:| Service | Base URL (Prod) | Jalur Endpoint | URL Lengkap |
|---|
| User | https://user.example.com | GET /user/{id} | https://user.example.com/user/{id} |
| Order | https://order.example.com | GET /order/{id} | https://order.example.com/order/{id} |
| Product | https://product.example.com | GET /product/{id} | https://product.example.com/product/{id} |
Tidak perlu placeholder {{BaseUrl}} manual; Apidog mendeteksi modul dan menerapkan base URL yang benar secara otomatis.
Permintaan#
Permintaan adalah pemanggilan API mandiri, tidak terikat pada spesifikasi endpoint, mirip dengan permintaan di Postman.Kemampuan Permintaan#
Buat secara independen dari spesifikasi. Parse permintaan yang berhasil menjadi spesifikasi endpoint. Gunakan untuk pengujian ad-hoc atau API yang tidak terdokumentasi.
Permintaan memberikan fleksibilitas untuk skenario ketika spesifikasi API belum ditentukan sebelumnya, menjembatani kesenjangan antara alur kerja design-first dan request-first.
Skenario Pengujian#
Skenario Pengujian menjalankan batch permintaan, serupa dengan Postman Collections, dengan fitur otomatisasi lanjutan.Fitur#
Kemampuan Lanjutan#
Laporan pengujian dan pengujian performa.
Skenario pengujian disinkronkan otomatis dengan perubahan spesifikasi API, memastikan pengujian tetap valid seiring API berkembang.
Mode Design-first & Mode Request-first#
Modul API Apidog memiliki dua mode yang dapat dialihkan di sudut kiri bawah antarmuka: Design-first Mode dan Request-first Mode.Kedua mode menyediakan fungsionalitas serupa tetapi dengan antarmuka yang berbeda, untuk memenuhi alur kerja tim yang berbeda.Mode Design-first#
Direkomendasikan untuk tim yang menerapkan desain API terlebih dahulu.
Tentukan spesifikasi API sebelum pengembangan dan pengujian.
Ideal untuk proyek yang terencana dan digerakkan oleh spesifikasi.
Mode Request-first#
Cocok untuk tim yang berfokus pada pengembangan backend terlebih dahulu.
Buat permintaan, lalu hasilkan spesifikasi dari pemanggilan yang berhasil.
Sempurna untuk API yang tidak terdokumentasi atau integrasi pihak ketiga.
Ringkasan#
Memahami konsep inti ini akan membantu Anda memanfaatkan pendekatan API-first Apidog untuk desain, pengujian, dan kolaborasi yang efisien. Mulailah dengan membuat proyek, mengorganisasi endpoint ke dalam modul, mendefinisikan lingkungan untuk berbagai tahap, dan membangun skenario pengujian untuk otomatisasi.Untuk bacaan lebih lanjut, jelajahi halaman dokumentasi yang ditautkan atau coba antarmuka Apidog untuk melihat konsep-konsep ini dalam praktik.
Siap Memulai?#
Mulai dari Awal
Mulai Menggunakan Apidog dari AwalMigrasi ke Apidog
Mulai dengan bermigrasi ke Apidog 