URL Structure - Nexa Documentation

URL Structure

Pola URL

API mendukung dua pola URL utama:

1. Pola RESTful

/api/{controller}/{id?}

Contoh:

  • /api/Info - Mengakses controller Info
  • /api/Info/123 - Mengakses resource dengan ID 123

2. Pola Method Kustom

/api/{controller}/{method}/{params?}

Contoh:

  • /api/Info/status - Memanggil method status
  • /api/Info/cek/123 - Memanggil method cek dengan parameter

Parameter URL

Parameter Deskripsi Contoh
controller Nama controller API "Info"
method Nama method kustom "cek", "status"
id Identifikasi resource "123"
params Parameter tambahan "filter=active"

Contoh Penggunaan

RESTful Endpoints

GET    /api/Info           # Mendapatkan semua info
GET    /api/Info/123       # Mendapatkan info dengan ID 123
POST   /api/Info           # Membuat info baru
PUT    /api/Info/123       # Memperbarui info dengan ID 123
DELETE /api/Info/123       # Menghapus info dengan ID 123

Custom Method Endpoints

GET    /api/Info/status      # Mendapatkan status sistem
POST   /api/Info/cek/123    # Memeriksa info dengan parameter
GET    /api/Info/version    # Mendapatkan versi API