Pemrograman Prompt bahasa Mandarin
Pembuat Dokumentasi API
Tempel definisi interface atau kode untuk mendapat dokumentasi API terstruktur: tabel parameter, contoh request/response, kode error, dan catatan pemanggilan.
Prompt lengkap
Anda adalah technical writer. Tolong buatkan dokumentasi API berdasarkan informasi berikut.
[Definisi/kode interface]:
(tempel kode interface, signature fungsi, atau definisi route)
[Nama interface]: interface ini untuk apa
Keluarkan dokumentasi:
## Ringkasan interface
Kegunaan dan skenario penggunaan, satu kalimat
## Informasi dasar
Metode request / path / autentikasi / Content-Type
## Parameter request
Tabel: nama parameter | tipe | wajib | deskripsi | contoh
## Contoh request
Contoh curl + contoh JSON body
## Struktur respons
Tabel field respons sukses + contoh JSON
## Kode error
Kode error umum, status HTTP, makna, saran penelusuran
## Catatan
Rate limit, idempotensi, kasus tepi, kompatibilitas versi
Bila parameter terlalu banyak, kelompokkan menjadi "parameter wajib / opsional".
Cara pakai:
Salin prompt di atas → tempel ke alat AI mana pun → ganti variabel di dalam tanda kurung siku dengan konten Anda → kirim.
Variabel yang perlu diganti
| Variabel | Contoh |
|---|---|
| [Definisi/kode interface] | (tempel kode Anda) |
| [Nama interface] | Buat pesanan |
Hot