GoHadits

GoHadits adalah API open-source sederhana yang dibangun menggunakan Golang untuk mengakses kumpulan hadits.

Baca dengan bahasa lain: English.

Prasyarat

Proyek ini dibangun menggunakan Go version 1.22.2, dan diharapkan untuk dikembangkan menggunakan versi Golang yang serupa untuk mendapatkan hasil sesuai harapan.

Cara Menjalankan

• Instalasikan dependensi proyek menggunakan perintah go mod download.
• Jalankan proyek dengan perintah go run . atau go run main.go.

Cara Membuat File Biner

Jalankan perintah berikut untuk membuat file biner:

go build -ldflags "-s -w" -o ./out .

Kemudian jalankan menggunakan perintah ./out.

Penggunaan

[GET] /api/v1/hadith

Mengembalikan daftar kitab hadits yang tersedia.

Respon sukses

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": [
    {
      "book": "bukhari",
      "name": "Bukhari",
      "total": 6638
    },
    {
      "book": "muslim",
      "name": "Muslim",
      "total": 4930
    }
  ],
  "message": "Hadith books successfully retrieved.",
  "status": "success"
}

Respon eror

Respon akan dikembalikan dalam bentuk JSON juga jika terdapat eror. Contohnya:

{
    "code": 500,
    "message": "Internal Server Error",
    "status": "error"
}

[GET] /api/v1/hadith/{book}

Mengembalikan daftar hadits yang terdapat pada kitab yang diminta.

Parameters

Nama	Keberadaan	Tipe	Deskripsi
book	wajib	param	Nama kitab hadits. (diambil dari data[i].book yang ada di api/v1/hadith)
limit	opsional	query	Jumlah hadits yang diambil dalam sekali request. Bawaannya adalah 50 dan maksimal 150.
offset	opsional	query	Indeks awal hadits diambil. Bawaannya adalah 0.

Respon sukses

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": {
    "contents": [
      {
        "number": 1,
        "arab": "حَدَّثَنَا عَبْدُ اللَّهِ بْنُ مَسْلَمَةَ بْنِ قَعْنَبٍ الْقَعْنَبِيُّ حَدَّثَنَا عَبْدُ الْعَزِيزِ يَعْنِي ابْنَ مُحَمَّدٍ عَنْ مُحَمَّدٍ يَعْنِي ابْنَ عَمْرٍو عَنْ أَبِي سَلَمَةَ عَنْ الْمُغِيرَةِ بْنِ شُعْبَةَأَنَّ النَّبِيَّ صَلَّى اللَّهُ عَلَيْهِ وَسَلَّمَ كَانَ إِذَا ذَهَبَ الْمَذْهَبَ أَبْعَدَ",
        "id": "Telah menceritakan kepada kami [Abdullah bin Maslamah bin Qa'nab al Qa'nabi] telah menceritakan kepada kami [Abdul Aziz yakni bin Muhammad] dari [Muhammad yakni bin Amru] dari [Abu Salamah] dari [Al Mughirah bin Syu'bah] bahwasanya Nabi shallallahu 'alaihi wasallam apabila hendak pergi untuk buang hajat, maka beliau menjauh."
      }
    ],
    "limit": 1,
    "name": "Abu Dawud",
    "offset": 0,
    "total": 4419
  },
  "message": "Hadith collection of Abu Dawud successfully retrieved.",
  "status": "success"
}

Respon eror

Respon akan dikembalikan dalam bentuk JSON juga jika terdapat eror. Contohnya:

{
  "code": 400,
  "message": "offset should not larger than total hadith available",
  "status": "error"
}

[GET] /api/v1/hadith/{book}/{number}

Mengembalikan hadits spesifik berdasarkan nomor hadits.

Parameters

Nama	Keberadaan	Tipe	Deskripsi
book	wajib	param	Nama kitab hadits. (diambil dari data[i].book yang ada di api/v1/hadith)
number	wajib	param	Nomor hadits.

Respon sukses

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": {
    "content": {
      "number": 5,
      "arab": "حَدَّثَنَا عَمْرُو بْنُ مَرْزُوقٍ أَخْبَرَنَا شُعْبَةُ عَنْ قَتَادَةَ عَنْ النَّضِرِ بْنِ أَنَسٍ عَنْ زَيْدِ بْنِ أَرْقَمَعَنْ رَسُولِ اللَّهِ صَلَّى اللَّهُ عَلَيْهِ وَسَلَّمَ قَالَ إِنَّ هَذِهِ الْحُشُوشَ مُحْتَضَرَةٌ فَإِذَا أَتَى أَحَدُكُمْ الْخَلَاءَ فَلْيَقُلْ أَعُوذُ بِاللَّهِ مِنْ الْخُبُثِ وَالْخَبَائِثِ",
      "id": "Telah menceritakan kepada kami [Amru bin Marzuq] telah mengabarkan kepada kami [Syu'bah] dari [Qatadah] dari [an Nadhr bin Anas] dari [Zaid bin Arqam] dari Rasulullah shallallahu 'alaihi wasallam, beliau bersabda: \"Sesungguhnya tempat buang hajat itu dihadiri oleh setan-setan, maka apabila salah seorang dari kalian mendatangi WC, hendaklah dia mengucapkan; 'Aku berlindung kepada Allah dari setan jantan dan setan betina'.\""
    },
    "name": "Abu Dawud",
    "total": 4419
  },
  "message": "Hadith no. 5 from book of Abu Dawud successfully retrieved.",
  "status": "success"
}

Respon eror

Respon akan dikembalikan dalam bentuk JSON juga jika terdapat eror. Contohnya:

{
  "code": 404,
  "message": "hadith no. 5000 from book of Abu Dawud is not found",
  "status": "error"
}

[GET] /api/v1/hadith/random

Mengembalikan hadits secara acak.

Respon sukses

Respon akan dikembalikan dalam bentuk JSON. Contohnya:

{
  "code": 200,
  "data": {
    "content": {
      "number": 5,
      "arab": "حَدَّثَنَا عَمْرُو بْنُ مَرْزُوقٍ أَخْبَرَنَا شُعْبَةُ عَنْ قَتَادَةَ عَنْ النَّضِرِ بْنِ أَنَسٍ عَنْ زَيْدِ بْنِ أَرْقَمَعَنْ رَسُولِ اللَّهِ صَلَّى اللَّهُ عَلَيْهِ وَسَلَّمَ قَالَ إِنَّ هَذِهِ الْحُشُوشَ مُحْتَضَرَةٌ فَإِذَا أَتَى أَحَدُكُمْ الْخَلَاءَ فَلْيَقُلْ أَعُوذُ بِاللَّهِ مِنْ الْخُبُثِ وَالْخَبَائِثِ",
      "id": "Telah menceritakan kepada kami [Amru bin Marzuq] telah mengabarkan kepada kami [Syu'bah] dari [Qatadah] dari [an Nadhr bin Anas] dari [Zaid bin Arqam] dari Rasulullah shallallahu 'alaihi wasallam, beliau bersabda: \"Sesungguhnya tempat buang hajat itu dihadiri oleh setan-setan, maka apabila salah seorang dari kalian mendatangi WC, hendaklah dia mengucapkan; 'Aku berlindung kepada Allah dari setan jantan dan setan betina'.\""
    },
    "name": "Abu Dawud",
    "total": 4419
  },
  "message": "Hadith no. 5 from book of Abu Dawud successfully retrieved.",
  "status": "success"
}

Respon eror

Respon akan dikembalikan dalam bentuk JSON juga jika terdapat eror. Contohnya:

{
  "code": 404,
  "message": "hadith no. 5000 from book of Abu Dawud is not found",
  "status": "error"
}

License

GoHadith adalah perangkat lunak open-source yang dilisensikan di bawah lisensi MIT license.