Analis Konsultasi Kontrak API
Untuk insinyur yang meninjau perubahan API yang dapat merusak klien, kontrak, atau jaminan kompatibilitas mundur.
Best for these models
๐ The Prompt
๐ Prompt tersedia dalam unduhan
Dapatkan teks prompt lengkap dalam file .txt yang dapat diunduh. Gratis, tanpa pendaftaran.
Unduh PromptVariables to fill in
{{CODE_DIFF}} โ Replace with your input {{API_STYLE}} โ Replace with your input {{COMPATIBILITY_RULES}} โ Replace with your input {{DOWNSTREAM_CLIENTS}} โ Replace with your input About this prompt
Analis Konsultasi Kontrak API dirancang untuk meninjau perubahan yang mempengaruhi bentuk request dan response, kode status, versi, dan jaminan kompatibilitas. Ini berfungsi seperti perancang API yang teliti, memeriksa apakah sebuah PR merusak klien, melemahkan kontrak, atau memperkenalkan perilaku ambigu. Sangat berguna untuk tim yang mendukung pelanggan eksternal, layanan multiple, atau endpoint publik dengan harapan kompatibilitas yang ketat.
Prompt ini ideal untuk insinyur backend, tim platform, dan pemilik API yang membutuhkan peninjauan kontrak yang tajam sebelum penggabungan. Ia memeriksa drift skema, penghapusan field, perubahan perilaku default, dan perbedaan penanganan error. Output membantu peninjau memutuskan apakah perubahan tersebut kompatibel mundur, membutuhkan versi, atau memerlukan catatan migrasi. Sangat membantu ketika beberapa konsumen bergantung pada endpoint yang sama dan perubahan kecil dapat menyebabkan gangguan luas.
Sesuaikan dengan {{CODE_DIFF}}, tipe API dalam {{API_STYLE}}, dan aturan kompatibilitas Anda dalam {{COMPATIBILITY_RULES}}. Jika endpoint memiliki konsumen yang diketahui, tambahkan mereka di {{DOWNSTREAM_CLIENTS}} agar model dapat menilai radius dampaknya. Respon mencakup risiko kompatibilitas, contoh respon yang disarankan, dan rekomendasi rilis. Gunakan bersama analisis cakupan pengujian untuk memastikan perilaku implementasi dan kontrak terlindungi.
Key features
- Memeriksa kompatibilitas mundur di seluruh perubahan request dan response.
- Menandai drift skema, penghapusan field, dan perubahan kode status.
- Berguna untuk API publik dan ekosistem layanan multiple.
- Merekomendasikan catatan migrasi dan alternatif yang lebih aman.
- Mendukung keputusan rilis untuk endpoint yang berhadapan langsung dengan klien.
Best for
- โ Pemilik API yang mengelola integrasi eksternal
- โ Insinyur backend yang mengirimkan perubahan skema
- โ Tim platform yang melindungi kontrak layanan
Tips
- ๐ก Daftarkan downstream consumers di {{DOWNSTREAM_CLIENTS}} untuk meningkatkan analisis radius dampak.
- ๐ก Tambahkan kebijakan versi Anda ke {{COMPATIBILITY_RULES}} untuk penilaian yang lebih ketat.
- ๐ก Gunakan ini bersama pengujian skema saat endpoint dibagikan antar tim.
What you'll get
Peninjauan kontrak yang menandai penghapusan field yang merusak, perubahan bentuk response, dan regresi kode status. Mungkin mengusulkan alternatif yang lebih aman seperti penambahan field atau endpoint versi. Output mencakup verdict kompatibilitas dan catatan migrasi singkat agar tim dapat mengkomunikasikan perubahan kepada downstream.
Preparing your download...
Unduh PromptPrompts terkait
API Mock Server Blueprinter
Untuk tim yang membangun layanan palsu yang mensimulasikan perilaku API yang realistis sebelum penyelesaian backend.
Dokumentasi Referensi API Forge
Untuk tim platform yang menghasilkan dokumentasi referensi API yang akurat dari skema, rute, atau catatan endpoint.
Arsitek Fixture Pengujian Backend
Untuk insinyur senior yang membuat fixture dan mock yang dapat digunakan kembali untuk rangkaian pengujian backend yang kompleks.
Decoder Jejak Stack Bug Hunter
Untuk pengembang yang membutuhkan penjelasan cepat dan akurat tentang crash, pengecualian, dan jejak stack dalam kode produksi.