Terdapat beberapa kriteria utama yang harus Anda penuhi dalam membuat proyek Music API.

Kriteria 1: Menggunakan Laravel

• API harus dibuat menggunakan Laravel, dengan minimal versi 9 (diperbolehkan menggunakan versi 9, 10, atau 11).
• Pastikan Anda menginstal versi Laravel yang sesuai sebelum memulai membuat aplikasi. Untuk informasi lebih lanjut bisa membuka dokumentasi official Laravel disini.
• Perlu diperhatikan bahwa setiap versi Laravel mempunyai kebutuhan yang berbeda, sebagai contoh Laravel 9 minimal harus menggunakan PHP 7.4.

Kriteria 2: Menggunakan MySQL sebagai database

• Data harus disimpan di dalam database menggunakan MySQL.
• Wajib mengkonfigurasi database seperti host, port, maupun kredensial dalam mengakses ke database pada file .env.
• Untuk informasi lebih lanjut mengenai tata cara menggunakan database MySQL di Laravel bisa membuka dokumentasi berikut.

Kriteria 3: Menggunakan database migration

• Wajib menggunakan teknik migrations dalam mengelola struktur tabel pada database.
• Jalankan perintah php artisan make:migration <nama_migration> untuk membuat migration.
• Baca dokumentasi mengenai database migration disini.

Kriteria 4: Menggunakan API Routes

• Wajib menggunakan API route pada laravel (route dibuat pada file routes/api.php).
• Karena routes didefinisikan pada file routes/api.php, maka otomatis route akan diberi prefix /api.
• Untuk melihat routes pada aplikasi laravel Anda, bisa menjalankan perintah php artisan route:list.

*Jika Anda menggunakan Laravel 11, maka perlu menjalankan perintah php artisan install:api sebelum mendefinisikan routes. Baca lebih lengkap disini.

Kriteria 5: API dapat menyimpan musik

API yang anda buat harus dapat menyimpan musik melalui route:

• Method: POST
• URL: /api/musics
• Body Request:

  {
      "title": string,
      "year": number,
      "artist": string,
      "genre": string,
      "duration": number
  }

Objek musik yang disimpan pada server harus memiliki struktur seperti contoh di bawah ini:

{
    "id": 1,
    "title": "Hey Jude", 
    "year": 1968,
    "artist": "The Beatles",  
    "genre": "Pop rock",
    "duration": 430,
    "created_at": 2024-03-31T03:20:51Z,
    "updated_at": 2024-03-31T04:02:55Z
}

Properti yang ditebalkan diolah dan di-generate di sisi server. Berikut penjelasannya: (Klik untuk melihat)

• id: nilai id haruslah unik. Untuk membuat nilai unik, Anda bisa memanfaatkan fitur increments() pada file migration, atau bisa menggunakan UUID. Anda bisa pelajari tentang primary key pada Laravel disini.
• created_at: merupakan properti yang menampung tanggal dimasukkannya musik. Anda bisa menggunakan timestamps() pada file migration Anda. Pada Laravel, properti ini otomatis terisi, jadi tidak perlu mengisi manual.
• updated_at: merupakan properti yang menampung tanggal kapan data musik diubah. Jika menggunakan timestamp() pada migration, maka otomatis properti ini akan dibuat. Nilai properti ini akan diubah otomatis oleh Laravel, ketika data diperbarui.

Bila musik berhasil dimasukkan, server harus mengembalikan respons data musik yang baru ditambahkan:

• Status code: 201
• Response body:

  {
      "id": 2,
      "title": "Arkadia", 
      "year": 2019,
      "artist": "Babymetal",
      "genre": "Metal",
      "duration": 319,
      "created_at": 2024-03-31T03:20:51Z,
      "updated_at": 2024-03-31T04:02:55Z
  }

Kriteria 6: API dapat menampilkan seluruh musik

API yang Anda buat harus dapat menampilkan seluruh musik yang disimpan melalui route:

• Method: GET
• URL: /api/musics

Server harus mengembalikan response dengan:

• Status code: 200
• Response body:

  [
      {
          "id": 1,
          "title": "Hey Jude",
          "artist": "The Beatles",
      },
      {
          "id": 2,
          "title": "Arkadia",
          "artist": "Babymetal",
      }
  ]

Jika belum terdapat musik yang dimasukkan, server bisa merespons dengan array kosong.

[]

Kriteria 7: API dapat menampilkan detail musik

API yang Anda buat harus dapat menampilkan detail musik yang disimpan melalui route:

• Method: GET
• URL: /api/musics/{id}

Bila musik dengan id yang dilampirkan ditemukan, maka server harus mengembalikan respons dengan:

• Status code: 200
• Response body:

  {
      "id": 2,
      "title": "Arkadia", 
      "year": 2019,
      "artist": "Babymetal",
      "genre": "Metal",
      "duration": 319,
      "created_at": 2024-03-31T03:20:51Z,
      "updated_at": 2024-03-31T04:02:55Z
  }

Bila musik dengan id yang dilampirkan oleh client tidak ditemukan, maka server harus mengembalikan respons dengan:

• Status code: 404
• Response body:

  {
      "status": "failed",
      "message": "musik tidak ditemukan"
  }

Kriteria 8: API dapat mengubah data musik

API yang Anda buat harus dapat menampilkan detail musik yang disimpan melalui route:

• Method: PUT
• URL: /api/musics/{id}
• Request body:

  {
      "title": ?string,
      "year": ?number,
      "artist": ?string,
      "genre": ?string,
      "duration": ?number
  }

  *Semua field pada request body opsional.

Bila musik berhasil diperbarui, server harus mengembalikan respons dengan data musik terbaru:

• Status code: 200
• Response body:

  {
      "id": 2,
      "title": "Arkadia", 
      "year": 2019,
      "artist": "Babymetal",
      "genre": "J-Pop",
      "duration": 319,
      "created_at": 2024-03-31T03:20:51Z,
      "updated_at": 2024-04-31T11:13:29Z
  }

Bila musik dengan id yang dilampirkan oleh client tidak ditemukan, maka server harus mengembalikan respons dengan:

• Status code: 404
• Response body:

  {
      "status": "failed",
      "message": "musik tidak ditemukan"
  }

Kriteria 9: API dapat menghapus musik

API yang Anda buat harus dapat menghapus detail musik yang disimpan melalui route:

• Method: DELETE
• URL: /api/musics/{id}

Bila musik berhasil dihapus, server harus mengembalikan respons berikut:

• Status code: 204
• Response body: empty (kosong)

Bila musik dengan id yang dilampirkan oleh client tidak ditemukan, maka server harus mengembalikan respons dengan:

• Status code: 404
• Response body:

  {
      "status": "failed",
      "message": "musik tidak ditemukan"
  }

Kriteria Opsional

Selain kriteria utama, terdapat kriteria opsional yang yang dapat Anda penuhi agar mendapat nilai yang baik.

Kriteria Opsional 1: Menerapkan data validation

Menerapkan proses Data Validation pada Request Payload sesuai spesifikasi berikut:

• POST /api/musics
  • title: required, string
  • year: required, number
  • artist: required, string
  • genre: required, string
  • duration: required, number
• PUT /api/musics/{id}
  • title: string
  • year: number
  • artist: string
  • genre: string
  • duration: number

Jika terdapat request body yang tidak valid, maka server harus mengembalikan response sebagai berikut:

{
    "message": "The title field is required. (and 1 more error)",
    "errors": {
        "title": [
            "The title field is required."
        ],
        "duration": [
            "The duration field is required."
        ]
    }
}

Jika menggunakan fitur Validation bawaan pada Laravel, maka server otomatis merespons seperti di atas jika terdapat input yang tidak valid. Untuk informasi lebih lanjut mengenai Validation pada Laravel bisa membuka link berikut.

Kriteria Opsional 2: Query Parameter untuk Pencarian Lagu

Menerapkan query parameter pada endpoint GET /api/musics untuk fitur pencarian musik. Berikut ketentuan parameternya:

• ?title: mencari musik berdasarkan judul musik.
• ?artist: mencari musik berdasarkan artist.

*Penggunaan kedua parameter tersebut dapat dikombinasikan.

Catatan

• Semua response dan request body yang disebutkan di atas dikirim dalam format JSON.