Pemeriksaan Kelengkapan Dokumentasi API

INFO

Lihat Memulai dengan Fitur AI untuk persyaratan penyiapan. Catatan: Fitur ini memerlukan Apidog versi 2.7.55 atau yang lebih baru.

Ikhtisar

Anda dapat menggunakan AI untuk menjalankan Pemeriksaan Kelengkapan Dokumentasi API pada dokumentasi API Anda saat ini dan menghasilkan laporan peninjauan yang terperinci. Berdasarkan laporan ini, Anda dapat menyempurnakan dan meningkatkan dokumentasi Anda — membuat kolaborasi menjadi lebih lancar, dokumentasi lebih mudah dibaca, dan semua fitur AI menjadi lebih efektif berkat spesifikasi endpoint yang lebih akurat.

Hal yang Diperiksa

Sebelum menjalankan Pemeriksaan Kelengkapan Dokumentasi API, sebaiknya tinjau apakah deskripsi dan definisi dalam dokumentasi API saat ini sudah lengkap. Pemeriksaan ini menganalisis aspek-aspek berikut:

1. Definisi Dasar

Periksa apakah dokumentasi endpoint dengan jelas dan akurat menetapkan:

Elemen	Tujuan
Metode Permintaan	Mendefinisikan metode HTTP (GET, POST, PUT, DELETE) untuk menentukan semantik permintaan, idempotensi, dan struktur parameter
Path Permintaan	Path URL lengkap (tidak termasuk URL dasar) untuk mengidentifikasi endpoint secara unik dan menyimpulkan struktur parameter path
Nama dan Deskripsi Endpoint	Penjelasan singkat tentang tujuan endpoint untuk membantu pembaca dan AI memahami logika bisnis

2. Deskripsi Parameter

Periksa apakah dokumentasi endpoint dengan jelas dan akurat menetapkan:

Elemen	Tujuan
Nama Parameter	Memastikan struktur parameter lengkap, penamaan konsisten, dan setiap parameter berada di lokasi yang benar (Params, Body, Headers, Cookies)
Contoh	Menyediakan nilai input sampel yang valid untuk membantu memahami nilai, format, tipe data, dan makna bisnis yang umum
Deskripsi	Menjelaskan makna, tujuan, dan skenario bisnis dari parameter

Informasi dasar parameter permintaan dapat dibuat atau dimodifikasi dengan bantuan AI.

3. Batasan Parameter

Periksa apakah dokumentasi endpoint dengan jelas dan akurat menetapkan:

Batasan	Tujuan
Wajib/Nullable	Menunjukkan apakah suatu parameter wajib diisi dan apakah nilai null diperbolehkan
Enums/Const	Mencantumkan kemungkinan nilai enum atau konstanta beserta maknanya
Nilai Batas	Menyediakan nilai minimum/maksimum, batas panjang, dan batasan lainnya
Format	Menjelaskan format khusus (date-time, email, uuid, binary, int64, json-string, dll.)

4. Respons

Periksa apakah dokumentasi API dengan jelas dan akurat menetapkan:

Elemen	Tujuan
Body Respons	Menyediakan struktur lengkap untuk tipe konten respons, penjelasan field, kode status HTTP, dan kode kesalahan

Informasi dasar respons juga dapat dibuat atau dimodifikasi dengan bantuan AI.

Pemeriksaan Kelengkapan Dokumentasi API

Anda dapat menemukan fitur Pemeriksaan Kelengkapan Dokumentasi API di sudut kanan atas halaman dokumentasi endpoint. Klik fitur tersebut untuk memulai pemeriksaan.

Jika fitur berwarna abu-abu, berarti fitur tersebut saat ini dinonaktifkan. Admin tim atau organisasi harus terlebih dahulu mengaktifkannya di pengaturan. Selain itu, pastikan klien Apidog Anda telah diperbarui ke versi terbaru.

Setelah Anda memulai pemeriksaan, AI akan meninjau dokumentasi endpoint saat ini berdasarkan kriteria yang telah ditentukan. Kemudian, AI menghasilkan laporan terperinci dengan skor, penjelasan, dan saran optimisasi yang dapat ditindaklanjuti untuk setiap item peninjauan — membantu Anda dengan cepat melihat apa yang kurang dan bagaimana cara memperbaikinya.

Pemeriksaan Kelengkapan Dokumentasi API

Ikhtisar#

Hal yang Diperiksa#

1. Definisi Dasar#

2. Deskripsi Parameter#

3. Batasan Parameter#

4. Respons#

Pemeriksaan Kelengkapan Dokumentasi API#

Ikhtisar

Hal yang Diperiksa

1. Definisi Dasar

2. Deskripsi Parameter

3. Batasan Parameter

4. Respons

Pemeriksaan Kelengkapan Dokumentasi API