diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..329b04f --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# kamusd + +Proyek sumber terbuka implementasi HTTP API untuk Kamus Besar Bahasa +Indonesia. + + +## HTTP API + +Kamusku HTTP API adalah jantung dari semua implementasi di atas dan pencarian +definisi kata di bawah. +Kamusku HTTP API dapat diakses menggunakan HTTP lewat URL berikut: `/api` + + +### API Definisi + +HTTP API untuk mencari definisi dari satu atau lebih kata. + +Format permintaan, + +``` +GET /api/definisi?kata=<string>,... +``` + +Format respon dalam JSON, + +``` +{ + "<string>": { + "dasar": "<string>", + "pesan": "<string>", + "definisi": [{ + "isi": "<string>", + "kelas": [<string>], + "contoh": [<string>] + }, + ... + ] + } +} +``` + +Jika kata tidak ditemukan atau bila kata bukan kata baku, bagian "pesan" akan +berisi keterangan yang menjelaskan galat dari pencarian. + +Berikut contoh pemanggilan API untuk mencari definisi dari kata "kamus", +"bahaza" (kata tidak ditemukan), dan "analisa" (kata tidak baku): + +``` +/api/definisi?kata=kamus,bahaza,analisa +``` + +## KamuskuBot - Bot Telegram + +Dengan tersedianya API, membuka banyak implementasi terbuka lain, salah +satunya yaitu Bot untuk aplikasi Telegram: https://t.me/KamuskuBot + +Untuk saat ini, KamuskuBot hanya punya satu perintah yaitu "/definisi". Cara +menggunakan perintah ini hampir sama dengan program kamusku yaitu dengan +memberikan kata yang dicari, contohnya, + +``` +/definisi kamus,bahasa +``` + + +Sekian, selamat meretas! |