65 lines
1.5 KiB
Markdown
65 lines
1.5 KiB
Markdown
# search_endpoints
|
||
|
||
按关键词搜索端点。支持跨模块搜索，也可以限定在特定模块内。
|
||
|
||
## 参数
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
|------|------|------|------|
|
||
| `keyword` | string | 是 | 搜索关键词 |
|
||
| `moduleId` | string | 否 | 限定搜索范围的模块 ID，不填则搜索所有模块 |
|
||
|
||
## 搜索范围
|
||
|
||
关键词会匹配以下字段（不区分大小写）：
|
||
- 端点路径（`path`）
|
||
- 端点摘要（`summary`）
|
||
- 端点描述（`description`）
|
||
- 操作标识符（`operationId`）
|
||
|
||
## 返回结果
|
||
|
||
```json
|
||
[
|
||
{
|
||
"id": "ep_001",
|
||
"method": "POST",
|
||
"path": "/v1/charges",
|
||
"summary": "Create a charge",
|
||
"moduleName": "Payments",
|
||
"deprecated": false
|
||
},
|
||
{
|
||
"id": "ep_005",
|
||
"method": "POST",
|
||
"path": "/v1/payment_intents",
|
||
"summary": "Create a PaymentIntent",
|
||
"moduleName": "Payments",
|
||
"deprecated": false
|
||
}
|
||
]
|
||
```
|
||
|
||
## 返回字段说明
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| `id` | string | 端点 ID，可传给 `get_endpoint_detail` |
|
||
| `method` | string | HTTP 方法 |
|
||
| `path` | string | API 路径 |
|
||
| `summary` | string | 端点摘要 |
|
||
| `moduleName` | string | 所属模块名称 |
|
||
| `deprecated` | boolean | 是否已弃用 |
|
||
|
||
最多返回 **20 条**结果，按路径和方法排序。
|
||
|
||
## Token 消耗
|
||
|
||
约 **200-500 tokens**。
|
||
|
||
## 使用场景
|
||
|
||
- 不知道端点在哪个模块，通过关键词搜索
|
||
- 快速定位与某个功能相关的端点
|
||
- 模糊搜索，如搜索 "user" 找到所有用户相关端点
|