60 lines
1.3 KiB
Markdown
60 lines
1.3 KiB
Markdown
# list_endpoints
|
||
|
||
列出指定模块中的所有端点摘要信息。
|
||
|
||
## 参数
|
||
|
||
| 参数 | 类型 | 必填 | 说明 |
|
||
|------|------|------|------|
|
||
| `moduleId` | string | 是 | 模块 ID，可从 `get_project_overview` 或 `list_modules` 获取 |
|
||
|
||
## 返回结果
|
||
|
||
```json
|
||
[
|
||
{
|
||
"id": "ep_001",
|
||
"method": "POST",
|
||
"path": "/v1/charges",
|
||
"summary": "Create a charge",
|
||
"deprecated": false
|
||
},
|
||
{
|
||
"id": "ep_002",
|
||
"method": "GET",
|
||
"path": "/v1/charges/{id}",
|
||
"summary": "Retrieve a charge",
|
||
"deprecated": false
|
||
},
|
||
{
|
||
"id": "ep_003",
|
||
"method": "POST",
|
||
"path": "/v1/refunds",
|
||
"summary": "Create a refund",
|
||
"deprecated": false
|
||
}
|
||
]
|
||
```
|
||
|
||
## 返回字段说明
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| `id` | string | 端点 ID，用于 `get_endpoint_detail` |
|
||
| `method` | string | HTTP 方法（GET、POST、PUT、DELETE 等） |
|
||
| `path` | string | API 路径 |
|
||
| `summary` | string | 端点简短描述 |
|
||
| `deprecated` | boolean | 是否已弃用 |
|
||
|
||
结果按路径字母排序，然后按 HTTP 方法排序。
|
||
|
||
## Token 消耗
|
||
|
||
约 **200-500 tokens**，取决于模块中的端点数量。
|
||
|
||
## 使用场景
|
||
|
||
- 浏览特定模块中的所有端点
|
||
- 找到目标端点的 ID，用于调用 `get_endpoint_detail`
|
||
- 了解 API 提供了哪些操作
|