Pengubahan Kasus String snake_case, camelCase, dan Mengapa Penting dalam API

Pengaturan kasus string adalah salah satu hal yang tidak dipikirkan oleh pengembang sampai secara diam-diam menghancurkan sesuatu di produksi. Antarmuka JavaScript di depan mengirimkan userId tetapi backend Python mengharapkan user_id. ORM secara diam-diam mengubah nama kolom SQL Anda. Tugas CI gagal karena variabel lingkungan ditulis salah.

Konvensi kasus ada karena bahasa, kerangka kerja, dan sistem yang berkembang secara terpisah — masing-masing dengan idioma mereka sendiri. Memahami format mana yang sesuai di mana, dan tahu cara mengubah antara mereka, adalah keterampilan praktis yang menghemat waktu debugging.

Format kasus utama

Berikut adalah ringkasan cepat dari apa yang Anda temui di dunia nyata, dan di mana setiap format adalah pilihan yang tepat:

Konteks	Konvensi	Contoh	Catatan
Variabel JavaScript / kunci JSON	kasus unta	userId, firstName	Sebagian besar API REST mengikuti format ini
Variabel Python / kunci JSON	kasus_ular	user_id, first_name	Default Django, FastAPI, SQLAlchemy
Nama kelas (kebanyakan bahasa)	Kasus Pascal	UserProfile, ApiResponse	Juga dikenal sebagai UpperCamelCase
Jalur URL	kebab-case	/user-profile, /api-docs	Lebih baik untuk SEO daripada garis bawah
Variabel lingkungan	SCREAMING_SNAKE	DATABASE_URL, API_KEY	Universal di semua shell dan platform CI
Kepala HTTP	Train-Case	Content-Type, X-Api-Key	Standar HTTP/1.1
Kolom / tabel SQL	kasus_ular	user_id, created_at	Konvensi PostgreSQL, MySQL

Mengapa ketidaksesuaian kasus menghancurkan integrasi API

Sumber paling umum dari kerusakan adalah batas antara JavaScript dan Python. Ekosistem JavaScript — React, Node, API browser — menghasilkan camelCase. Ekosistem Python — FastAPI, Django REST Framework, SQLAlchemy — mengharapkan snake_case.

Ketika klien JavaScript mengirimkan payload ini:

{
  "firstName": "Alice",
  "userId": 42
}

Server Python yang mengakses request.json["first_name"] mendapatkan KeyError. Tidak ada peringatan, tidak ada fallback — hanya kegagalan. FastAPI dapat mengatasi ini dengan alias_generator = to_camel pada model Pydantic, tetapi konfigurasi ini adalah pilihan yang tidak diaktifkan oleh kebanyakan tim sampai mereka menemukan bug tersebut.

Masalah yang sama muncul di batas JavaScript/GraphQL, antara microservices yang ditulis dalam bahasa berbeda, dan di mana saja Anda mendeserialisasi JSON tanpa peta field eksplisit.

Pengubahan secara programatis

Sebagian besar bahasa telah menyelesaikan ini, tetapi pendekatan yang digunakan berbeda.

JavaScript: Pilihan yang paling bersih adalah change-case (ringan) atau lodash (_.camelCase, _.snakeCase). Jika Anda lebih memilih untuk melewatkan ketergantungan:

// camelCase → snake_case
const toSnakeCase = str =>
  str.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);

toSnakeCase('userName');   // 'user_name'
toSnakeCase('createdAt');  // 'created_at'

Python: Itu re modul menangani hal ini, tetapi versi satu langkah gagal pada akronim seperti HTTPSProxy. Gunakan pendekatan dua langkah:

import re

def to_snake_case(name):
    s1 = re.sub(r'(.)([A-Z][a-z]+)', r'\1_\2', name)
    return re.sub(r'([a-z0-9])([A-Z])', r'\1_\2', s1).lower()

to_snake_case('userName')    # 'user_name'
to_snake_case('HTTPSProxy')  # 'https_proxy'

Menggabungkan semuanya: handler webhook siap produksi Koleksi bawaan tidak mencakup konverter kasus. github.com/iancoleman/strcase adalah pilihan umum:

import "github.com/iancoleman/strcase"

strcase.ToSnake("UserName")  // "user_name"
strcase.ToCamel("user_name") // "UserName"
strcase.ToKebab("UserName")  // "user-name"

Jika Anda membutuhkan konversi cepat tanpa menulis kode, maka IO Tools String Case Converter mengelola camelCase, PascalCase, snake_case, kebab-case, SCREAMING_SNAKE, dan lainnya — tanpa instalasi yang diperlukan.

Konvensi database dan kegagalan ORM

Database SQL — PostgreSQL, MySQL, SQLite — biasanya menggunakan snake_case untuk nama kolom dan tabel. user_id, created_at, payment_method. Ini adalah format yang diharapkan, dan query SQL mentah akan mencerminkannya.

ORM sering secara otomatis mengubah antara konvensi nama bahasa Anda dan database, yang nyaman sampai tidak lagi. Sequelize mengubah camelCase JavaScript menjadi snake_case secara default dalam beberapa konfigurasi — kecuali ketika tidak, tergantung pada opsi model, dialect, atau versi. Prisma menghasilkan nama field camelCase yang berpeta ke kolom snake_case. ActiveRecord memperluas nama tabel dan mengubah semua menjadi snake_case.

Langkah pragmatis: jadilah eksplisit. Definisikan nama kolom dalam definisi model Anda, bukan mengandalkan konversi otomatis. Ini membuat peta terlihat dalam tinjauan kode dan menghindari kejutan saat Anda menjalankan query mentah atau beralih ke ORM lain.

Jalur URL: gunakan kebab-case, bukan garis bawah

Untuk jalur URL, kebab-case adalah rekomendasi yang jelas. Dokumentasi Google secara historis menganggap tanda hubung sebagai pemisah kata dan garis bawah sebagai penggabung kata. URL seperti /string-case-converter mengindikasikan dua kata yang terpisah; /string_case_converter dibaca sebagai satu token panjang.

Implikasi praktisnya: URL dengan kebab-case berperilaku lebih baik dalam pengoptimalan kata kunci multi-kata di pencarian. Ini bukan faktor penilaian besar, tetapi tidak ada biaya untuk benar dari hari pertama.

API besar sepakat — GitHub, Stripe, dan Twilio semua menggunakan kebab-case untuk jalur URL. Bagian seperti /api/v1/user-profiles mudah dibaca, mudah di ketik, dan konsisten dengan standar web.

File konfigurasi: SCREAMING_SNAKE untuk variabel lingkungan, camelCase untuk YAML

Variabel lingkungan secara universal menggunakan SCREAMING_SNAKE_CASE. DATABASE_URL, AWS_SECRET_ACCESS_KEY, REDIS_HOST — konvensi ini berlaku di Linux, Docker, Kubernetes, dan setiap platform CI/CD yang Anda temui. Shell mengekspor variabel dengan format ini. Jangan melawan hal ini.

File konfigurasi YAML mengatakan hal yang berbeda. Manifest Kubernetes, Docker Compose, dan alur kerja GitHub Actions menggunakan camelCase untuk kunci — apiVersion, containerPort, imagePullPolicy. Ansible adalah satu-satunya pengecualian, menggunakan snake_case di seluruh definisi tugasnya.

Aturan di sini sederhana: sesuaikan format yang diharapkan oleh alat. Jangan berusaha menormalisasi di semua file konfigurasi Anda — ini menciptakan ketidaksesuaian tanpa menghemat usaha.

Mendapatkan konversi yang tepat

Tabel di atas mencakup sebagian besar skenario. Keterampilan nyata adalah mengetahui kapan ketidaksesuaian kasus menyebabkan kesalahan runtime dan kapan kerangka kerja secara diam-diam menangani hal tersebut. Saat Anda bekerja di batas bahasa, periksa apa yang dilakukan serializer atau ORM Anda — jangan asumsikan konversi otomatis terjadi.

Untuk konversi cepat, satu kali, tanpa menulis kode, maka IO Tools String Case Converter mengelola semua format utama dalam satu tempat. Tempel string, pilih format tujuan, selesai.

Anda mungkin juga menyukai