HTTP/HTTPS
请求协议
EagletAPI / OpenAPI / 姓名转拼音接口
姓名转拼音接口
接口地址：http://api.kittyhawks.cn/api/app.php?s=App.Pinyin.Name
接口描述： 姓名转拼音，姓名的姓的读音有些与普通字不一样，比如 ‘单’ 常见的音为 dan，而作为姓的时候读 shan。
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| text | 字符串 | 必须 | - | 待转为拼音的字符串内容 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.pinyin | 字符串 | 姓名对应的拼音字符串 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| text | 必须 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/App.Pinyin.Name.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | 表示客户端参数错误 |
| 404 | 表示接口服务不存在 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-11-21 20:21:29