Diperlukan Apidog versi 2.7.22 atau yang lebih baru.
Apidog sangat merekomendasikan agar semua dokumentasi API dirancang sesuai dengan OpenAPI (Swagger) Specification. Anda dapat merujuk ke artikel ini untuk memahami mengapa mengikuti spesifikasi ini penting bagi API Anda.Banyak fitur Apidog lainnya, seperti pemeriksaan kepatuhan endpoint yang didukung AI, penamaan AI, dan lainnya, bergantung pada panduan desain API yang lengkap dan terdefinisi dengan baik. Dengan panduan yang terstandardisasi:Fitur Apidog lainnya bekerja dengan lebih efektif
Tim Anda selaras dan mengikuti prinsip desain yang konsisten
Di Apidog, Anda dapat membuat panduan desain API baru dengan mengeklik "+"> "Panduan desain API baru" di atas pohon folder.Saat membuat panduan desain API baru, Anda akan memiliki dua opsi:1.
Templat contoh (direkomendasikan)
Gunakan templat panduan desain API lengkap yang disediakan oleh Apidog. Ini adalah pilihan yang direkomendasikan dalam sebagian besar kasus. Templat ini didasarkan pada OAS (OpenAPI Specification) dan disusun dengan merujuk pada praktik terbaik Microsoft untuk desain API.
2.
Templat kosong
Buat templat desain kosong. Opsi ini hanya menyediakan struktur dasar spesifikasi tanpa konten terperinci. Anda kemudian dapat menulis panduan desain API milik tim Anda sendiri. Jika tim Anda sudah memiliki standar dan praktik terbaik yang ditetapkan, ini mungkin menjadi titik awal yang lebih baik.
Setelah memilih, mempratinjau, dan mengonfirmasi templat yang sesuai dengan kebutuhan Anda, panduan desain API baru akan dibuat di dalam proyek Anda. Anda dapat sepenuhnya menyesuaikan isinya sesuai kebutuhan. Panduan desain akan ditampilkan di bagian atas pohon folder untuk mengingatkan semua anggota tim tentang pentingnya spesifikasi.Modified at 2026-06-11 10:17:04