C# Academy · Pelajaran

Strategi Pemberian Versi API

Terapkan versi melalui URL, header, dan string kueri.

Strategi Pemberian Versi API adalah pelajaran C# Academy gratis di CoddyKit. Ini adalah pelajaran 1 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 C# Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus C# Academy mencakup 4 pelajaran total.

Mengapa Membuat Versi API?

Setelah klien bergantung pada API Anda, Anda tidak dapat merusak kontraknya. Pembuatan versi memungkinkan Anda merilis perubahan yang merusak kompatibilitas dalam versi baru, sementara klien lama tetap bekerja dengan versi lama.

// v1 returns { name }
// v2 returns { firstName, lastName }  (breaking)

Pembuatan Versi pada Jalur URL

Strategi yang paling terlihat menempatkan versi di dalam jalur. Strategi ini tidak ambigu dan mudah digunakan untuk merutekan, menjelajah, serta menyimpan dalam cache.

GET /api/v1/products
GET /api/v2/products

Pembuatan Versi melalui String Kueri

Versi dikirim sebagai parameter kueri. URL tetap stabil, dan parameter yang tidak ada dapat menggunakan versi terbaru atau versi tertentu sebagai bawaan.

GET /api/products?api-version=1.0
GET /api/products?api-version=2.0

Pembuatan Versi melalui Tajuk

Tajuk permintaan khusus membawa versi, sehingga URL tetap bersih. Kekurangannya: versi tidak terlihat di bilah alamat peramban dan lebih sulit diuji secara manual.

GET /api/products
X-Api-Version: 2.0

Pembuatan Versi melalui Tipe Media

Juga disebut negosiasi konten. Versi disematkan dalam tipe media tajuk Accept. Ini adalah pilihan yang paling sesuai dengan REST, tetapi paling sulit ditemukan.

GET /api/products
Accept: application/json;v=2.0

Membandingkan Strategi

Setiap strategi menukar kemudahan ditemukan dengan kerapian URL:

Jalur URL: paling mudah ditemukan, tetapi membuat URL lebih ramai.
String kueri: URL stabil, nilai bawaan mudah diterapkan.
Tajuk: URL bersih, tetapi tersembunyi dari peramban.
Tipe media: REST paling murni, tetapi paling sulit digunakan.

// Many teams pick URL path for public APIs

Pemberian Versi Semantik pada API

Versi API biasanya hanya menggunakan versi mayor (v1, v2). Simpan versi minor untuk perubahan tambahan yang tidak merusak kompatibilitas dan dapat diabaikan oleh klien lama.

// v1.0 -> v1.1 : additive (safe)
// v1   -> v2   : breaking (new version)

Penandaan Usang

Jangan pernah menghapus versi lama secara tiba-tiba. Tandai sebagai usang, umumkan tanggal penghentian, dan beri tahu klien melalui tajuk.

// Response header on a deprecated version:
// Sunset: Wed, 31 Dec 2026 23:59:59 GMT
// Deprecation: true

Versi Bawaan

Tentukan apa yang terjadi ketika klien tidak mengirimkan versi. Pilihan umum: gunakan versi terbaru, gunakan v1, atau tolak permintaan. Kejelasan sejak awal mencegah kejutan.

// Strategy: unversioned request -> treat as v1.0

Membuat Versi pada Hal yang Tepat

Buat versi pada kontrak (rute, bentuk permintaan/respons), bukan pada detail implementasi internal. Titik akhir v2 dapat berbagi sebagian besar logika bisnis dengan v1.

// Same service, two thin controllers:
// ProductsV1Controller, ProductsV2Controller

Menggabungkan Strategi

Pustaka pembuatan versi ASP.NET Core dapat membaca versi dari beberapa sumber sekaligus, sehingga klien dapat memilih sumber yang paling nyaman. Anda akan mengonfigurasinya berikutnya.

// Accept version from URL OR header OR query

Pemeriksaan Singkat

Uji pemahaman Anda tentang strategi pembuatan versi.

Ringkasan

Anda telah mempelajari berbagai strategi pembuatan versi API:

Jalur URL, string kueri, tajuk, dan tipe media.
Setiap strategi menukar kemudahan ditemukan dengan kerapian URL.
Buat versi pada kontrak, tandai versi usang dengan baik, dan tentukan versi bawaan.

Berikutnya: mengonfigurasi Asp.Versioning di ASP.NET Core.

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Strategi Pemberian Versi API” gratis?

Ya — teks lengkap “Strategi Pemberian Versi API” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus C# Academy, upgrade ke CoddyKit PRO. Kursus C# Academy mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Strategi Pemberian Versi API”?

Terapkan versi melalui URL, header, dan string kueri. Kamu berlatih C# 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 C# Academy?

Tidak diperlukan pengalaman sebelumnya. C# 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 1 dari 4.

Berapa lama pelajaran “Strategi Pemberian Versi API” 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 C# Academy ini?

Ya. Setiap pelajaran C# 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 C# Academy