YiyanAPI/README.md · ByUsiTeam/docs

# 一言开放接口文档

## 接口概述
本接口提供随机返回一条中文短句的服务，支持多种数据格式的输出。

### 基础信息
```
接口地址: api.www.byusi.cn/yy
请求方式: GET
字符编码: UTF-8
```

## 请求参数

| 参数名 | 必填 | 类型   | 说明                                                                 |
|--------|------|--------|--------------------------------------------------------------------|
| form   | 否   | string | 指定响应格式，可选值：`json`/`text`/`xml`/`ini`（默认text格式） |

## 响应格式

### 成功响应
根据请求参数返回对应格式的数据：

**text格式 (默认)**
```
Content-Type: text/plain
示例: 人生若只如初见，何事秋风悲画扇
```

**json格式**
```json
Content-Type: application/json
示例: {"message":"人生若只如初见，何事秋风悲画扇"}
```

**xml格式**
```xml
Content-Type: text/xml
示例: <?xml version="1.0" encoding="UTF-8"?><message>人生若只如初见，何事秋风悲画扇</message>
```

**ini格式**
```ini
Content-Type: text/plain
示例: [RandomLine]
content=人生若只如初见，何事秋风悲画扇
```

### 错误响应
当出现以下情况时返回纯文本错误提示：
- 无效格式参数：`Invalid format requested.`
- 数据源异常：`Service temporarily unavailable`

所有错误响应均使用标准HTTP状态码：
- 400 Bad Request（参数错误）
- 500 Internal Server Error（服务端异常）

## 使用示例

### cURL请求
```bash
curl "api.www.byusi.cn/yy?form=json"
```

### Python示例
```python
import requests

response = requests.get("api.www.byusi.cn/yy", params={"form": "json"})
print(response.json())
```

## 使用限制
1. 请勿用于商业用途
2. 建议设置500ms以上的请求间隔
3. 请勿构造自动化高频请求

## 常见问题

Q: 返回的内容是否有分类过滤？
A: 当前版本为全量随机返回，暂不支持分类功能

Q: 是否支持HTTPS？
A: 支持HTTPS协议

Q: 数据更新频率？
A: 内容库不定期更新，无固定更新周期

Q: 是否支持跨域请求？
A: 当前允许所有域名的跨域访问(CORS)

> 最后更新：2025-03-17
> 如有疑问请联系 admin@520world.top

ByUsiTeam/docs

简介

发行版

贡献者

近期动态

ByUsiTeam/docs .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

ByUsiTeam/docs