Song Library API

Introduction

The Song Library API provides a set of endpoints to manage songs within a music library. The API allows users to perform CRUD (Create, Read, Update, Delete) operations on songs, as well as retrieve paginated results, fetch song lyrics, and more. It also includes integrated Swagger documentation for easier exploration of the available endpoints.

Installation

Prerequisites

• Go 1.18 or higher
• A running instance of the SongService (a service layer to manage song data)

Steps

1. Clone the repository:

   git clone https://github.com/KarmaBeLike/SongLibrary.git
   
   

START PROJECT

• install dependencies:

go mod tidy

• run project:

go run ./cmd

• Listing songs data with filtering and pagination:

  GET /api/songs
  

  GET /api/songs?group=Queen&page=1
  

  • queries for filtering:
    • group
    • song
  • queries for pagination:
    • page
    • limit
  • sample output:

  "songs": [
      {
          "id": 16,
          "group": "Queen",
          "song": "Bohemian Rhapsody",
          "text": null,
          "releaseDate": null,
          "link": null,
          "limit": 0,
          "page": 0,
          "total": 0,
          "verses": null
      }
  

• Listing verses with pagination:

  GET /api/songs/lyrics?id=41&page=1&limit=1
  

  • queries for pagination:
    • page
    • limit
  • sample output:

  {
  "id": 41,
  "group": "Muse",
  "song": "Supermassive Black Hole",
  "verses": [
      "Ooh baby, don't you know I suffer?\nOoh baby, can you hear me moan?\nYou caught me under false pretenses\nHow long before you let me go?"
  ]   
  }
  
  

• Adding new song data

  POST /api/songs
  

  • output body:

  {
  "id": "1,message":"Song added successfully" 
  }
  

• Update song info:

  • required parameter: id

  PATCH /api/songs?id=2
  

  • output body:

  
   {
  "id": 2,
  "message": "Song updated successfully."
  
  }
  

• Delete song info:

  • required parameter: id

  DELETE /api/songs?id=39
  

  • output body:

  
   {
  "id": 39,
  "message": "Song deleted successfully."
  
  }