Coding & data · Dua fase
Rancang endpoint REST API sebelum menulis kode
Fase 1 menurunkan daftar resource dan endpoint dari kebutuhan; fase 2 menulis kontrak lengkap berisi contoh request, response, kode status, dan pesan error.
2 langkah5 isianDiperbarui
Untuk: Programmer backend pemula, mahasiswa, dan tim kecil yang membangun API untuk aplikasi web atau mobile.
Diadaptasi dari prompts.chat (CC0)
Prompt siap salin
Kirim berurutan dalam satu percakapan, satu pesan per langkah, dan baca jawabannya sebelum lanjut.
Fase 1 — daftar endpoint
Saya akan membuat REST API untuk {{aplikasi, misalnya pemesanan ruang rapat kantor}} dengan {{Node.js Express / Laravel / FastAPI / lainnya}}. Pengguna dan hak aksesnya: {{misalnya karyawan bisa memesan, admin bisa mengelola ruang}}. Kebutuhan fitur: {{daftar fitur, satu per baris dan bernomor}} Belum perlu kode. Susun tabel endpoint: Metode | Path | Fungsi | Siapa yang boleh | Kebutuhan nomor berapa. Pakai kata benda jamak untuk resource (misalnya /rooms, /bookings), metode HTTP sesuai artinya, dan tunjukkan endpoint mana yang butuh paginasi atau filter. Tandai kebutuhan yang belum jelas aturannya sebagai pertanyaan; jangan mengarang aturan bisnis.Fase 2 — kontrak tiap endpoint
Kirim setelah tabel endpoint kamu setujui.
Tabel yang saya setujui: {{tempel tabel final}}. Untuk tiap endpoint, tulis kontraknya: parameter path dan query, contoh body request dalam JSON, contoh response sukses, kode status untuk sukses dan setiap kegagalan (400, 401, 403, 404, 409, 422) beserta bentuk pesan error yang seragam, dan validasi input per field. Tutup dengan potongan spesifikasi OpenAPI 3 dalam YAML untuk dua endpoint pertama. Contoh data memakai nilai rekaan yang jelas palsu, bukan data pengguna sungguhan; jangan mengarang field yang tidak berasal dari kebutuhan saya.
Isian yang harus kamu ganti
Ganti bagian yang disorot, termasuk tanda {{ }}.
- aplikasi, misalnya pemesanan ruang rapat kantor
- Node.js Express / Laravel / FastAPI / lainnya
- misalnya karyawan bisa memesan, admin bisa mengelola ruang
- daftar fitur, satu per baris dan bernomor
- tempel tabel final
Bedah prompt: kenapa ini bekerja
Tiap potongan di bawah dikutip persis dari prompt di atas.
Kebutuhan nomor berapa
Kolom ini memastikan setiap endpoint punya alasan dari kebutuhan, dan kebutuhan yang belum punya endpoint ikut ketahuan.
Siapa yang boleh
Hak akses yang dirancang sejak tabel endpoint mencegah lubang keamanan klasik, yaitu pengguna biasa bisa memanggil fungsi admin.
bentuk pesan error yang seragam
Aplikasi web atau mobile yang memanggil API jauh lebih mudah ditulis bila semua error punya bentuk yang sama di setiap endpoint.
nilai rekaan yang jelas palsu
Contoh di dokumentasi API kerap tersalin ke tes dan tangkapan layar, jadi tidak boleh berisi data orang sungguhan.
Kalau jawabannya belum pas
Kirim di percakapan yang sama. Perintah yang spesifik jauh lebih efektif daripada "perbaiki lagi".
Mau mulai menulis kode
Tulis kode untuk endpoint {{metode dan path}} saja dengan {{framework}}, mengikuti kontrak tadi: validasi input, kode status, dan bentuk pesan error yang sama. Sertakan dua tes untuk kasus sukses dan satu kasus gagal.
Kelas terkait
- HTTP dan API WebMembaca dan menyusun permintaan HTTP: URL, metode, kode status, header, JSON, REST, autentikasi, cache, dan galat.
- Backend Node.js Dasar: Rute, Middleware, dan PengujianMenulis sisi server API dengan pola Node.js: handler yang membaca request, rute, badan JSON, validasi, middleware, data, dan pengujian dengan request tiruan.
Prompt lain di Coding & data
- Jelaskan pesan error dan cari penyebabnyaIsian formulir · Isi formulir bahasa, perintah, pesan error lengkap, dan kode terkait, lalu dapat arti error, dugaan penyebab, dan cara membuktikannya.
- Query SQL dari pertanyaan bisnisPercakapan bertahap · Tempel skema tabel sekali, pastikan AI memahaminya, lalu ajukan pertanyaan satu per satu dan dapat query beserta penjelasannya.
- Regex dari contoh yang cocok dan tidakDengan contoh · Daftar teks yang harus cocok dan yang harus ditolak jadi soal latihan bagi AI, lalu regex-nya diuji terhadap setiap contoh.
- Pesan commit dan deskripsi pull requestDua fase · Fase 1 meringkas diff dan memeriksa apakah perlu dipecah; fase 2 menulis pesan commit dan deskripsi PR dari ringkasan yang kamu setujui.