README.md

January 1, 2026 Β· View on GitHub

Kotonogi API Logo

    Kotonogi API

Status GitHub Repo API Version


πŸ“Œ Ringkasan

Kotonogi API adalah API publik statis berbasis JSON yang menyediakan data huruf Jepang (Hiragana & Katakana) beserta variasinya seperti Dakuten, Handakuten, dan Yoon.

API ini ditujukan untuk:

  • pembelajaran bahasa Jepang,
  • eksperimen frontend/backend,
  • proyek edukasi dan non-komersial.

πŸ“ Tabel konten


🧐 Tentang API

Kotonogi API menyajikan data huruf Jepang dalam struktur JSON yang konsisten dan mudah dipahami.

Cakupan data meliputi:

  • Huruf dasar Hiragana dan Katakana

  • Variasi bunyi:

    • Dakuten (γ‚›)
    • Handakuten (γ‚œ)
    • Yoon (ゃゅょ)
  • Gambar cara menulis huruf (SVG)

  • Animasi urutan goresan (SVG)

  • Kosakata contoh untuk setiap huruf (jika tersedia)

Warning

API ini ditujukan untuk edukasi dan eksperimen, bukan untuk distribusi komersial skala besar tanpa izin. Semua aset SVG menyertakan informasi hak cipta di dalam file. Silahkan gunakan secara bijak


✨ Fitur

  • βœ… Data lengkap Hiragana & Katakana
  • βœ… Variasi Dakuten, Handakuten, dan Yoon
  • βœ… Gambar & animasi SVG (mudah di-embed)
  • βœ… API statis & gratis
  • βœ… Cocok untuk web, mobile, dan materi belajar

πŸ”— Endpoints

Base URL

https://kotonogi-api.vercel.app

πŸ“ Overview Endpoints

EndpointDeskripsi
GET /Informasi & dokumentasi singkat API
GET /fullSemua huruf Hiragana, Katakana, Dakuten, Handakuten, dan Yoon
GET /hirakataSemua Hiragana & Katakana
GET /dakutenSemua huruf Dakuten
GET /handakutenSemua huruf Handakuten
GET /yoonSemua huruf Yoon

🟦 Hiragana Endpoints

EndpointDeskripsi
GET /hiraganaDaftar lengkap Hiragana
GET /hiragana/fullDaftar lengkap Hiragana (termasuk Dakuten, Handakuten, dan Yoon)
GET /dakuten/hiraganaHiragana dengan Dakuten
GET /handakuten/hiraganaHiragana dengan Handakuten
GET /yoon/hiraganaHiragana Yoon
GET /hiragana/:romajiDetail huruf Hiragana berdasarkan romaji
GET /dakuten/hiragana/:romajiDetail huruf Dakuten Hiragana berdasarkan romaji
GET /handakuten/hiragana/:romajiDetail huruf Handakuten Hiragana berdasarkan romaji
GET /yoon/hiragana/:romajiDetail huruf Yoon Hiragana berdasarkan romaji

πŸŸ₯ Katakana Endpoints

EndpointDeskripsi
GET /katakanaDaftar lengkap Katakana
GET /katakana/fullDaftar lengkap Katakana (termasuk Dakuten, Handakuten, dan Yoon)
GET /dakuten/katakanaKatakana dengan Dakuten
GET /handakuten/katakanaKatakana dengan Handakuten
GET /yoon/katakanaKatakana Yoon
GET /katakana/:romajiDetail huruf Katakana berdasarkan romaji
GET /dakuten/katakana/:romajiDetail huruf Dakuten Katakana berdasarkan romaji
GET /handakuten/katakana/:romajiDetail huruf Handakuten Katakana berdasarkan romaji
GET /yoon/katakana/:romajiDetail huruf Yoon Katakana berdasarkan romaji

🎈 Cara Pakai

Contoh Request

curl https://kotonogi-api.vercel.app/hiragana
curl https://kotonogi-api.vercel.app/hiragana/a
curl https://kotonogi-api.vercel.app/dakuten

πŸ“¦ Format Response

Semua endpoint mengembalikan data dalam format JSON.

  • total: INT
  • tentang: STRING
  • info: STRING
  • penjelasan: STRING
  • romaji: STRING
  • kana: STRING
  • kakikata_gambar: URL_PATH
  • kakikata_animasi: URL_PATH
  • kosakata (opsional): ARRAY
  • arti: STRING
  • catatan (opsional): STRING

πŸ“¦ Contoh Output JSON

GET /full

Note

Endpoint /full disediakan untuk kebutuhan eksplorasi dan pembelajaran, bukan untuk konsumsi produksi skala besar.

{
  "hiragana": {
    "total": 23,
    "tentang": "Hiragana adalah salah satu sistem penulisan...",
    "info": "Hiragana biasanya digunakan untuk...",
    "penjelasan": "Hiragana juga memiliki variasi suara yang...",
    "hiragana_huruf": [
       {
        "romaji": "a",
        "kana": "あ",
        "kakikata_gambar": "https://kotonogi-api.vercel.app/images/hiragana/a.svg",
        "kakikata_animasi": "https://kotonogi-api.vercel.app/animation/hiragana/a.svg",
        "kosakata": [
            { "romaji": "ai", "kana": "あい", "arti": "cinta" },
            { "romaji": "asa", "kana": "あさ", "arti": "pagi" }
        ]
      }
    ]
  },
  "katakana": {
    "total": 23,
    "tentang": "Katakana adalah salah satu sistem penulisan...",
    "info": "Katakana lebih sering digunakan untuk...",
    "penjelasan": "Tanda ― (sering disebut 'chōon' atau 'long vowel mark') digunakan...",
    "katakana_huruf": [ {"romaji": "a", ...}, {...} ]
  },
  "dakuten": {
    "total": 50,
    "tentang": "Dakuten adalah tanda berupa dua garis kecil...",
    "info": "Dakuten sangat penting dalam bahasa Jepang karena...",
    "penjelasan": "Dakuten diterapkan pada lima baris konsonan dasar...",
    "hiragana_huruf": [ {"romaji": "ga", ...}, {...} ],
    "katakana_huruf": [ {"romaji": "ga", ...}, {...} ],
  },
  "handakuten": {
    "total": 10,
    "tentang": "Handakuten adalah tanda berupa lingkaran kecil yang...",
    "info": "Handakuten sangat penting dalam bahasa Jepang...",
    "penjelasan": "Handakuten hanya diterapkan pada baris h dalam...",
    "hiragana_huruf": [ {"romaji": "ga", ...}, {...} ],
    "katakana_huruf": [ {"romaji": "pa", ...}, {...} ]
  },
  "yoon": {
    "total": 72,
    "tentang": "Huruf gabungan dalam bahasa Jepang biasanya merujuk pada...",
    "info": "Huruf seperti げゃ, げゅ, げょ lebih sering digantikan oleh...",
    "penjelasan": "Dalam bahasa Jepang, huruf gabungan ini sering...",
    "hiragana_huruf": [ {"romaji": "ga", ...}, {...} ],
    "katakana_huruf": [ {"romaji": "gya", ...}, {...} ]
  }
}

GET /hiragana

{
  "total": 23,
  "tentang": "Hiragana adalah salah satu sistem penulisan...",
  "info": "Hiragana biasanya digunakan untuk menulis kata-kata...",
  "penjelasan": "Hiragana juga memiliki variasi suara...",
  "hiragana_huruf": [
    {
      "romaji": "a",
      "kana": "あ",
      "kakikata_gambar": "https://kotonogi-api.vercel.app/images/hiragana/a.svg",
      "kakikata_animasi": "https://kotonogi-api.vercel.app/animation/hiragana/a.svg",
      "kosakata": [
        { "romaji": "ai", "hiragana": "あい", "arti": "cinta" },
        { "romaji": "asa", "hiragana": "あさ", "arti": "pagi" }
      ]
    }
  ]
}

GET /hiragana/a

{
  "romaji": "a",
  "kana": "あ",
  "kakikata_gambar": "https://kotonogi-api.vercel.app/images/hiragana/a.svg",
  "kakikata_animasi": "https://kotonogi-api.vercel.app/animation/hiragana/a.svg",
  "kosakata": [
    { "romaji": "ai", "hiragana": "あい", "arti": "cinta" },
    { "romaji": "asa", "hiragana": "あさ", "arti": "pagi" }
  ]
}

πŸš€ Roadmap

  • πŸ”œ Website dokumentasi interaktif
  • πŸ”œ Endpoint untuk pencarian huruf berdasarkan romaji (untuk semua jenis huruf)
  • πŸ”œ Penambahan kosakata beserta arti dan contoh penggunaan
  • πŸ”œ Pengoptimalan performa dan caching