Flask Academy · Pelajaran

Amplop Error JSON Seragam

Seragamkan bentuk error untuk klien API.

Pelajaran 4 dari 413 langkah

Amplop Error JSON Seragam adalah pelajaran Flask Academy gratis di CoddyKit. Ini adalah pelajaran 4 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Flask Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Flask Academy mencakup 4 pelajaran total.

Satu Bentuk untuk Setiap Kesalahan

Format kesalahan yang beragam membingungkan klien. Amplop yang seragam membuat setiap kegagalan terlihat sama, sehingga aplikasi cukup mengurainya sekali dan dapat mempercayainya.

Isi Sebuah Amplop

Amplop yang baik membawa pesan kesalahan yang stabil dan sebuah kode. Klien membaca bidang-bidang ini, bukan menebak dari teks mentah.

{
  "error": "Not found",
  "code": 404
}

Tambahkan Kode untuk Mesin

Selain pesan, sertakan string kode yang singkat. Klien dapat membuat percabangan berdasarkan kode itu dengan aman meskipun teks untuk manusia nantinya diubah.

{
  "error": "Not found",
  "code": "post_missing"
}

Buat di Dalam Fungsi Pembantu

Bungkus pembuatan amplop dalam fungsi pembantu kecil. Setiap penangan memanggilnya, sehingga bentuknya tidak pernah berbeda-beda.

def envelope(msg, code):
    return jsonify(error=msg, code=code)

Gunakan di Dalam Penangan

Setiap errorhandler mengembalikan fungsi pembantu beserta status. Kode status dan isi respons kini selalu selaras di seluruh API Anda.

return envelope("Not found", 404), 404

Tangkap HTTPException Secara Terpusat

Daftarkan satu penangan untuk HTTPException guna membungkus setiap kesalahan bawaan. Satu tempat itu memformat 404, 400, dan lainnya.

@app.errorhandler(HTTPException)
def wrap(e):
    return envelope(e.description, e.code), e.code

Sertakan Detail Bidang

Untuk validasi, tambahkan bidang detail yang mencantumkan input mana yang gagal. Klien kemudian dapat menyoroti bidang yang tepat dan bermasalah.

{
  "error": "Invalid",
  "details": {"email": "required"}
}

Selaraskan Status dan Isi

Angka di dalam isi harus sesuai dengan status HTTP yang sebenarnya. Ketidaksesuaian akan merusak klien yang lebih mempercayai salah satunya.

Jangan Bocorkan Detail Internal

Jangan pernah menaruh jejak tumpukan di dalam amplop. Catat secara pribadi dan tampilkan kepada klien hanya pesan umum yang aman.

Dokumentasikan Formatnya

Tuliskan bentuk amplop Anda agar setiap titik akhir mengikutinya. Kontrak yang terdokumentasi membuat seluruh API Anda mudah diprediksi.

Mengapa Ini Menguntungkan

Satu bentuk kesalahan yang stabil membuat kode klien lebih sederhana dan bug lebih jarang. Tim dapat membangun di atas API yang dapat diprediksi dengan jauh lebih sedikit hambatan.

Pemeriksaan Singkat

Mengapa Anda perlu memberikan string kode kesalahan yang stabil kepada klien?

Jawab di pelajaran interaktif

Ringkasan

Anda merancang amplop JSON seragam dengan pesan, kode, dan detail, membungkus kesalahan secara terpusat, serta menyelaraskan status dan isi. Anda berhasil!

Gratis untuk memulai

Belajar Python dengan tutor AI — gratis

Tulis dan jalankan kode asli di browser kamu, dapatkan bantuan instan dari tutor AI 24/7, dan lanjutkan di mana kamu tinggalkan di web atau aplikasi.

Kursus: 30
Pelajaran: 120

Mulai belajar gratis Lihat kursus lengkapnya

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Amplop Error JSON Seragam” gratis?

Ya — teks lengkap “Amplop Error JSON Seragam” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Flask Academy, upgrade ke CoddyKit PRO. Kursus Flask Academy mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Amplop Error JSON Seragam”?

Seragamkan bentuk error untuk klien API. Kamu berlatih Flask Academy dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai Flask Academy?

Tidak diperlukan pengalaman sebelumnya. Flask Academy di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 4 dari 4.

Berapa lama pelajaran “Amplop Error JSON Seragam” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran Flask Academy ini?

Ya. Setiap pelajaran Flask Academy menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

← Kembali ke Flask Academy