Skip to content

abdipr/jagokata-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 

Repository files navigation

JagoKata

JagoKata REST API

API RESTful untuk mengambil data kutipan, peribahasa, dan informasi tokoh dari situs JagoKata. API ini menyediakan berbagai endpoint untuk mengakses kutipan populer, kutipan acak, pencarian kutipan, dan banyak lagi.

✨ Dukungan

Jika kamu menyukai project ini, silakan berikan bintang di repository ini, terima kasih ⭐
Kamu juga bisa mendukung saya dengan cara:
Trakteer Saya

Daftar Isi

🚀 Memulai

Pengenalan

JagoKata REST API adalah API yang memberikan akses terstruktur ke data kutipan, peribahasa, dan informasi tokoh dari situs JagoKata. API ini cocok untuk aplikasi yang memerlukan data kutipan dan peribahasa secara dinamis tanpa harus langsung mengakses situs JagoKata.

Persyaratan

  • PHP 7.4 atau lebih baru
  • simple_html_dom.php untuk parsing HTML
  • Akses internet untuk scraping situs JagoKata

Instalasi

  1. Clone repository ini ke server:

    git clone https://github.com/abdipr/jagokata-api.git
    cd jagokata-api
  2. Download dan sertakan simple_html_dom.php di direktori project.

  3. Atur server kamu untuk menyajikan file PHP (misal: Apache atau Nginx).

  4. Atau, kamu bisa langsung deploy ke Vercel
    Deploy with Vercel

❇️ Referensi

Endpoints

Base URL: https://jagokata-api.vercel.app

Endpoint Deskripsi Parameter
GET /popular Mendapatkan quotes populer page
GET /acak Mendapatkan quotes secara acak page
GET /search Mencari quotes q, page
GET /tokoh Mencari quotes dari huruf inisial huruf
GET /author Mendapatkan semua quotes dari seorang author name, page
GET /peribahasa Mendapatkan peribahasa dari kata kata
GET /peribahasa-acak Mendapatkan 10 peribahasa secara acak

Parameter Request

Parameter Deskripsi
q Query pencarian
huruf Inisial nama tokoh
name Nama tokoh lengkap
kata Kata kunci untuk peribahasa
page Indikator halaman (opsional)

Parameter Response

Parameter Deskripsi
id ID unik dari quotes
author Nama tokoh yang mengucapkan quotes
text Teks dari quotes atau peribahasa
category Kategori dari tokoh
source Sumber kutipan (jika tersedia)

💥 Penanganan Error

Semua error mengembalikan objek JSON dengan kode status dan message yang menjelaskan masalah.

  • 404 Error:
    • Ketika halaman tidak ditemukan atau parameter query hilang.
    {
      "status": "404",
      "author": "abdiputranar",
      "message": "Page not found"
    }

🌐 Contoh

Contoh 1: Mendapatkan Quotes Populer

Ambil quotes populer tanpa parameter:

GET https://jagokata-api.vercel.app/popular

Contoh 2: Mencari Quotes

Cari kutipan dengan kata kunci tertentu:

GET https://jagokata-api.vercel.app/search?q=kehidupan

Contoh 3: Mencari Quotes Berdasarkan Tokoh

Ambil semua quotes dari tokoh dengan nama inisial tertentu:

GET https://jagokata-api.vercel.app/tokoh?huruf=A

Catatan

  • Parameter q: Digunakan untuk pencarian quotes.
  • Parameter huruf: Digunakan untuk menemukan tokoh berdasarkan inisial.
  • Parameter name: Nama lengkap tokoh untuk mengambil semua quotes mereka.
  • Parameter kata: Kata kunci untuk mencari peribahasa.

🌱 Kontribusi

Kontribusi diperbolehkan! Untuk berkontribusi:

  1. Fork repository ini.
  2. Buat branch fitur baru: git checkout -b fitur-baru.
  3. Commit perubahanmu: git commit -m 'Menambahkan fitur'.
  4. Push ke branch: git push origin fitur-baru.
  5. Buat pull request.

⚖️ Lisensi

Project ini dilisensikan di bawah MIT License. Lihat file LICENSE untuk informasi lebih lanjut.

⚠️ Disclaimer

Data yang disediakan oleh API ini diperoleh dari situs JagoKata melalui proses web scraping. Developer yang menggunakan API ini harus mengikuti peraturan yang berlaku dengan mencantumkan project ini atau pemilik resmi dalam project mereka dan dilarang menyalahgunakan API ini untuk keuntungan pribadi.

⬆️ Kembali ke Atas

About

Unofficial JagoKata REST API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages