Desain API yang Baik — API

API yang baik adalah API yang mudah dipahami, konsisten, dan predictable. Prinsip RESTful: Gunakan noun, bukan verb: /users bukan /getUsers Gunakan plural: /use

API yang baik adalah API yang mudah dipahami, konsisten, dan predictable.

Prinsip RESTful:

  1. Gunakan noun, bukan verb: /users bukan /getUsers
  2. Gunakan plural: /users bukan /user
  3. Nested resources: /users/5/posts bukan /getUserPosts?userId=5
  4. Method = aksi: GET = baca, POST = buat, PUT = update, DELETE = hapus

Versioning:

/api/v1/users
/api/v2/users

Versi baru tanpa break versi lama.

Konsisten response format:

// Sukses
{ "data": {...}, "message": "Success" }

// Error
{ "error": { "code": "NOT_FOUND", "message": "User not found" } }

// List
{ "data": [...], "meta": { "page": 1, "total": 100 } }

Filter, sort, search:

GET /products?category=electronics&sort=price&order=desc&search=laptop

Idempotency:

Yang akan kamu pelajari