导入 Postman / Swagger:用 OpenAPI 文档管理生成文章摘要接口
生成文章摘要OpenAPIPostmanSwaggerAPI治理 # 导入 Postman / Swagger:用 OpenAPI 文档管理生成文章摘要接口
> 接口 961-1 · 免费(受使用档次限制) · 集成方式 OpenAPI 3.0 · 适用人群:API 治理团队、后端工程师 · 阅读时间:约 6 分钟
## 核心要点
- 官方提供标准 OpenAPI 3.0 文档(YAML / JSON),覆盖本接口全部接入点。
- 可导入 **Postman / Swagger UI** 管理接口、生成请求模板与 Mock。
- 文档地址:`https://www.showapi.com/openapi/market/961.yaml` 与 `.json`。
## Why:把接口纳入团队 API 资产
当团队有多个接口要统一管理、要出在线文档、要生成 Mock 给前端联调时,OpenAPI 文档是事实标准。把生成文章摘要接口的 YAML 导入你常用的工具,就能在团队已有的 API 工作流里直接调用和协作。
## What:OpenAPI 资源
| 资源 | 链接 |
|------|------|
| OpenAPI YAML(在线/下载) | https://www.showapi.com/openapi/market/961.yaml |
| OpenAPI JSON | https://www.showapi.com/openapi/market/961.json |
文档中标注的接入点:`/961-1`,必填参数 `text`、`num`,鉴权为 query 参数 `appKey`。
> 说明:官方 OpenAPI 将 `list` 的 type 标为 `string`,但实际返回为字符串数组,以实际返回为准(详见 [返回字段全解](https://www.showapi.com/guides/article-summary-response-fields-961))。
## How:导入到常用工具
### 方案 A:Postman
1. 打开 Postman → 左上角 `Import`。
2. 选择 `Link` 粘贴:`https://www.showapi.com/openapi/market/961.yaml`,或下载 YAML 后选择 `File` 上传。
3. 导入后会在集合里生成「生成文章摘要」请求,预填了 `POST /961-1` 与参数。
4. 在请求 URL 的 query 里填入你的 `appKey`,Body 选 `x-www-form-urlencoded`,填 `text` 与 `num` 即可发送。
### 方案 B:Swagger UI
1. 打开 Swagger UI(本地或你们团队托管的实例)。
2. `File` / `URL` 方式加载 `https://www.showapi.com/openapi/market/961.yaml`。
3. 找到 `POST /961-1`,点击 `Try it out`,填入 `appKey`、`text`、`num` 执行。
4. 响应区会展示完整的 JSON 结构,便于核对字段。
### 方案 C:Swagger Editor(本地编辑/校验)
1. 打开 Swagger Editor。
2. `File → Import URL` 粘贴 YAML 地址,或粘贴文件内容。
3. 右侧实时预览文档,可导出为其他格式接入 CI。
## 返回示例与解析
导入后请求得到的真实结构:
```json
{
"showapi_res_code": 0,
"showapi_fee_num": 1,
"showapi_res_body": {
"ret_code": "0",
"list": ["提升学习效率", "AI带来的不仅是效率提升", "在制造领域"]
}
}
```
## 进阶 / 边界
- **Mock 联调**:Swagger UI / Postman 可基于 OpenAPI 生成 Mock,前端可先按 `list` 为字符串数组对接。
- **文档与实际不一致**:以真实返回为准(`list` 是数组),导入后如工具按 `string` 校验,属已知 schema 偏差。
- **鉴权位置**:`appKey` 在 query 参数,导入后确认请求 URL 已带 `?appKey=YOUR_APPKEY`。
## FAQ
**Q1:除了 Postman 和 Swagger UI,还支持 Swagger Editor 吗?**
A:支持。Swagger Editor 可加载同一份 YAML 做本地编辑与校验,三者基于同一份 OpenAPI 文档,按团队习惯选择即可。
**Q2:导入后参数不全?**
A:确认导入的是 `market/961.yaml`(接口级全量),若只看到部分字段可重新拉取最新 YAML。
**Q3:YAML 和 JSON 用哪个?**
A:功能等价,Postman/Swagger 多支持 YAML;按团队工具习惯选择。
**Q4:Mock 返回的 `list` 是数组吗?**
A:是,真实返回为字符串数组;若 Mock 按 schema 给单字符串,属官方 schema 标注偏差,以真实返回为准。
**Q5:能用于自动化测试吗?**
A:可以,Postman 集合可接入 Newman 做接口自动化,注意免费额度(每次扣 1 次)。
## 相关能力 / 下一步阅读
- [通过 MCP 协议在 AI 客户端中直接调用生成文章摘要](https://www.showapi.com/guides/article-summary-mcp-961)
- [生成文章摘要返回字段全解:showapi_res_body 与 list / ret_code 一文读懂](https://www.showapi.com/guides/article-summary-response-fields-961)
- **本系列共 8 篇**:查看[生成文章摘要指南总目录](https://www.showapi.com/guides/article-summary-guides-961)