Dalam cabang sprint yang baru dibuat, secara default tidak ada konten. Pendekatan ini membantu pengembang berfokus pada perubahan yang diperlukan untuk sprint saat ini. Anda dapat menambahkan sumber daya dan melakukan modifikasi menggunakan dua metode utama.Memilih Pendekatan Anda#
| Metode | Paling Sesuai Untuk | Manfaat Utama |
|---|
| Perubahan Manual | Pengembangan API-First | Spesifikasi yang jelas sebelum pengembangan |
| Impor OAS | Pengembangan Code-First | Perbandingan otomatis dengan cabang utama |
Apidog sangat merekomendasikan pendekatan API-First (perubahan manual) untuk meningkatkan efisiensi dan menurunkan biaya kolaborasi.
Perubahan Manual#
Memodifikasi konten secara manual dalam cabang sprint memungkinkan Anda mendefinisikan spesifikasi API dengan jelas sebelum masuk ke tahap pengembangan.Melakukan Fork Sumber Daya dari Cabang Utama#
Ketika Anda perlu memodifikasi endpoint, skema, atau komponen respons yang sudah ada berdasarkan kebutuhan sprint saat ini:1.
Gunakan Fork from main untuk membuat salinan sumber daya yang diperlukan
2.
Semua folder induk diimpor secara otomatis
3.
Sumber daya yang diimpor ditandai dengan indikator asosiasi
Menarik Perubahan Terbaru dari Cabang Utama#
Saat bekerja dalam cabang sprint, pembaruan mendesak mungkin memerlukan perubahan langsung di cabang utama. Untuk menyinkronkan:1.
Anda akan menerima notifikasi ketika sumber daya terkait di cabang utama diperbarui
2.
Klik notifikasi untuk meninjau perubahan
3.
Pilih apakah akan menarik pembaruan atau mempertahankan konten cabang sprint saat ini
4.
Pilih konten yang diinginkan dan konfirmasikan pembaruan
Membuat Sumber Daya Baru#
Untuk membuat endpoint, skema, atau komponen respons baru untuk sprint saat ini:1.
Gunakan fitur New untuk menambahkan sumber daya ke cabang sprint saat ini
2.
Jika folder induk yang diperlukan tidak ada, gunakan:Select Endpoint Folders: Pilih folder yang sudah ada
New Endpoint Folder: Buat folder baru
Mengurutkan Ulang dan Menyesuaikan Isi Folder#
Anda dapat melakukan operasi yang sama pada sumber daya yang diimpor atau yang baru dibuat seperti di cabang utama:Seret untuk mengurutkan ulang:Folder yang diimpor dengan indikator:Menghapus dan Memulihkan Sumber Daya#
Cabang sprint memiliki fitur tempat sampah yang bekerja sama seperti cabang utama:1.
Hapus sumber daya sesuai kebutuhan
2.
Lihat sumber daya yang dihapus di Trash
3.
Pulihkan sumber daya saat diperlukan
Mengimpor, menghapus, dan memulihkan sumber daya cabang utama yang sama secara berulang dapat menyebabkan masalah data yang tidak terduga. Minimalkan operasi ini untuk menjaga integritas data.
Melakukan Mock, Membandingkan, dan Berkolaborasi#
Endpoint dalam cabang sprint memiliki alamat mock unik yang khusus untuk cabang tersebut, sepenuhnya bergantung pada definisi endpoint cabang sprint saat ini.Membandingkan dengan cabang utama:Bandingkan sumber daya cabang sprint dengan padanannya di cabang utama untuk mengidentifikasi perbedaan tertentu.Bagikan endpoint cabang sprint melalui tautan kolaborasi dengan anggota proyek lainnya.Saat mengeklik tautan kolaborasi endpoint cabang sprint ketika berada di cabang lain, sistem akan meminta Anda untuk beralih cabang. Simpan setiap perubahan di cabang Anda saat ini sebelum beralih.
Impor OAS#
Impor file OpenAPI Specification (OAS) langsung ke cabang sprint menggunakan metode impor manual, terjadwal, atau API.Mengimpor OAS ke Cabang Sprint#
1.
Pastikan cabang target dipilih di sudut kiri atas
2.
Navigasikan ke Project Settings → Import Data
3.
Impor data ke cabang saat ini
Perbandingan Otomatis dengan Cabang Utama#
Saat mengimpor OAS ke cabang sprint, logika pemrosesannya adalah:1.
Bandingkan "Path & Method" setiap endpoint dalam file OAS dengan cabang utama
2.
Jika identik: Endpoint tidak akan diimpor
3.
Jika berbeda: Endpoint diasosiasikan dengan cabang utama dan diimpor
4.
Jika baru: Endpoint baru dibuat dalam cabang sprint
1.
Bandingkan nama skema dalam file OAS dengan cabang utama
2.
Jika identik: Skema tidak akan diimpor
3.
Jika berbeda: Skema diasosiasikan dengan cabang utama dan diimpor
4.
Jika baru: Skema baru dibuat dalam cabang sprint
Sumber daya yang sama sekali tidak berubah dibandingkan dengan cabang utama tidak akan disertakan dalam cabang sprint setelah impor, sehingga membantu pengembang berfokus pada perubahan yang diperlukan.
