https://github.com/crizmo/kanaapi
KanaAPI is a simple API built with Express.js that provides information about Japanese Kana characters (Hiragana and Katakana).
https://github.com/crizmo/kanaapi
api express hiragana japanese kana katakana
Last synced: 17 days ago
JSON representation
KanaAPI is a simple API built with Express.js that provides information about Japanese Kana characters (Hiragana and Katakana).
- Host: GitHub
- URL: https://github.com/crizmo/kanaapi
- Owner: crizmo
- License: mit
- Created: 2025-01-13T09:18:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-16T09:16:39.000Z (over 1 year ago)
- Last Synced: 2025-03-30T03:17:00.266Z (about 1 year ago)
- Topics: api, express, hiragana, japanese, kana, katakana
- Language: HTML
- Homepage: https://kanaapi.vercel.app
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KanaAPI
KanaAPI is a simple API built with Express.js that provides information about Japanese Kana characters (Hiragana and Katakana).
- `data/kana.json`: Contains the Kana characters data.
- `index.js`: Main server file that sets up the API endpoints.
## Installation
1. Clone the repository:
```sh
git clone https://github.com/crizmo/KanaAPI
cd kanaapi
```
2. Install dependencies:
```sh
npm install
```
## Usage
1. Start the server:
```sh
npm start
```
2. The server will run on `http://localhost:3000` by default.
## API Endpoints
- **Get Kana data by character**
```
GET /api/kana/:character
```
Example: `GET /api/kana/あ`
- **Get Kana data by type**
```
GET /api/:type
```
Example: `GET /api/hiragana`
- **Get Kana chart by type**
```
GET /api/chart/:type
```
Example: `GET /api/chart/hiragana`
Response:
```json
{
"a": ["あ", "か", "さ", "た", "な", "は", "ま", "や", "ら", "わ"],
"i": ["い", "き", "し", "ち", "に", "ひ", "み", "り"],
"u": ["う", "く", "す", "つ", "ぬ", "ふ", "む", "ゆ", "る"],
"e": ["え", "け", "せ", "て", "ね", "へ", "め", "れ"],
"o": ["お", "こ", "そ", "と", "の", "ほ", "も", "よ", "ろ", "を"]
}
```