Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pepebecker/pinyin-rest
Rest API to convert Chinese characters to Pinyin and convert between Pinyin with tone marks and Pinyin with tone numbers.
https://github.com/pepebecker/pinyin-rest
api cangjie chinese hanzi mandarin pinyin rest
Last synced: 1 day ago
JSON representation
Rest API to convert Chinese characters to Pinyin and convert between Pinyin with tone marks and Pinyin with tone numbers.
- Host: GitHub
- URL: https://github.com/pepebecker/pinyin-rest
- Owner: pepebecker
- License: mit
- Created: 2017-04-18T23:59:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-10T17:13:58.000Z (over 5 years ago)
- Last Synced: 2024-10-30T19:23:51.553Z (15 days ago)
- Topics: api, cangjie, chinese, hanzi, mandarin, pinyin, rest
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/pinyin-rest
- Size: 146 KB
- Stars: 33
- Watchers: 5
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pinyin REST
[](https://david-dm.org/pepebecker/pinyin-rest)
[](https://david-dm.org/pepebecker/pinyin-rest#info=devDependencies)
[](https://opensource.org/licenses/MIT)
[](https://gitter.im/pepebecker)
## Install
```shell
npm install pinyin-rest
```
## `GET /pinyin/...`
### Examples
```shell
GET: https://api.pinyin.pepe.asia/pinyin/我的猫喜欢喝牛奶
=> {
"text": "wǒ de māo xǐhuan hē niúnǎi",
"data": ["wǒ ", ["de", "dī", "dí", "dì"], " māo xǐhuan ", ["hē", "hè"], " niúnǎi"]
}
```
```shell
GET: https://api.pinyin.pepe.asia/pinyin/wo3 xi3huan1 he1 cha2
=> {
"text": "wǒ xǐhuān hē chá",
"data": "wǒ xǐhuān hē chá"
}
```
```shell
GET: https://api.pinyin.pepe.asia/pinyin/woxihuanhecha?split=true
=> {
"text": "wo xi huan he cha",
"data": ["wo", "xi", "huan", "he", "cha"]
}
```
## `GET /definition/...`
### Example
```shell
GET: https://api.pinyin.pepe.asia/definition/的
=> {
"de5": [
"of",
"~'s (possessive particle)",
"(used after an attribute)",
"(used to form a nominal expression)",
"(used at the end of a declarative sentence for emphasis)"
],
"di1": [
"see 的士[di1 shi4]"
],
"di2": [
"really and truly"
],
"di4": [
"aim",
"clear"
]
}
```
## `GET /hanzi/...`
### Example
```shell
GET: https://api.pinyin.pepe.asia/hanzi/苹果
=> {
"traditional": "蘋果",
"simplified": "苹果",
"data": {
"ping2 guo3": {
"mandarin": "píng guǒ",
"definitions": [
"apple"
],
"classifiers": {
"ge4": {
"traditional": "個",
"simplified": "个",
"mandarin": "gè",
"definition": "classifier for people or objects in general"
},
"ke1": {
"traditional": "顆",
"simplified": "颗",
"mandarin": "kē",
"definition": "classifier for small spheres, pearls, corn grains, teeth, hearts, satellites etc"
}
}
}
}
}
```
## Related
- [`pinyin-utils`](https://github.com/pepebecker/pinyin-utils)
- [`pinyin-split`](https://github.com/pepebecker/pinyin-split)
- [`find-hanzi`](https://github.com/pepebecker/find-hanzi)
- [`hsk-words`](https://github.com/pepebecker/hsk-words)
- [`cedict`](https://github.com/pepebecker/cedict)
- [`mdbg`](https://github.com/pepebecker/mdbg)
- [`pinyin-or-hanzi`](https://github.com/pepebecker/pinyin-or-hanzi)
- [`hanzi-to-pinyin`](https://github.com/pepebecker/hanzi-to-pinyin)
- [`pinyin-convert`](https://github.com/pepebecker/pinyin-convert)
- [`pinyin-api`](https://github.com/pepebecker/pinyin-api)
- [`pinyin-bot-core`](https://github.com/pepebecker/pinyin-bot-core)
- [`pinyin-telegram`](https://github.com/pepebecker/pinyin-telegram)
- [`pinyin-messenger`](https://github.com/pepebecker/pinyin-messenger)
- [`pinyin-line`](https://github.com/pepebecker/pinyin-line)
- [`pinyin-chrome`](https://github.com/pepebecker/pinyin-chrome)
- [`pinyin-cli`](https://github.com/pepebecker/pinyin-cli)
- [`hanzi-cli`](https://github.com/pepebecker/hanzi-cli)
## Contributing
If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/pepebecker/pinyin-rest/issues).