PDF文件正文抽取:导入 Postman / Swagger 用 OpenAPI 文档管理接口
OpenAPIPostmanSwaggerAPI治理 # PDF文件正文抽取:导入 Postman / Swagger 用 OpenAPI 文档管理接口
> 接口 PDF文件正文抽取(apiCode=10,接入点 10-1) · 免费服务 · 提供 OpenAPI 3.0 文档 · 适用人群 API 治理团队、开发者 · 阅读时间 约 4 分钟
## 核心要点
- 官方提供标准 OpenAPI 3.0 文档(YAML / JSON),覆盖本接口全部接入点。
- 可导入 **Postman / Swagger UI / Swagger Editor** 自动生成请求模板与 Mock,便于调试与团队共享。
- 本文统一以 Postman / Swagger 表述,避免引入未经验证的工具链路。
## Why:为什么要用 OpenAPI 文档
手写请求容易漏参数、拼错地址。OpenAPI 文档把接口的地址、方法、参数、返回结构都定义成机器可读的规范——导入工具后,请求模板自动生成,团队成员无需看源码就能上手,还能一键生成 Mock 做前端联调。对注重 API 治理的团队尤其省事。
## What:文档地址
| 格式 | 地址 |
|------|------|
| OpenAPI YAML(在线/下载) | https://www.showapi.com/openapi/market/10.yaml |
| OpenAPI JSON | https://www.showapi.com/openapi/market/10.json |
> 说明:以上为官方提供的接口级 OpenAPI 3.0 文档,覆盖 apiCode=10 的全部接入点(10-1)。
## How:导入到常用工具
**方式一:Postman**
1. 打开 Postman → 选择「Import」。
2. 粘贴上面的 YAML 地址,或先下载 `10.yaml` 再选择文件导入。
3. 导入后自动生成请求集合,填入你的 `appKey` 即可调试。
**方式二:Swagger UI**
1. 打开 Swagger UI(自托管或官方在线编辑器)。
2. 通过「File → Import URL」填入 `https://www.showapi.com/openapi/market/10.yaml`。
3. 文档加载后即可在页面内直接试调(Try it out)。
**方式三:Swagger Editor**
1. 打开 Swagger Editor。
2. 粘贴 YAML 内容或导入文件,左侧即显示完整接口定义,右侧可交互调试。
下载命令(任选):
```bash
curl -O https://www.showapi.com/openapi/market/10.yaml
curl -O https://www.showapi.com/openapi/market/10.json
```
## 返回示例与解析
导入后,工具会按文档渲染出 `POST /10-1` 接口,参数面板含 `pdf`(File,必填)与鉴权所需的 `appKey`。返回结构(系统级 + `showapi_res_body`)也会一并展示,便于对照解析。
## 进阶 / 边界
- **Mock 联调**:Swagger/Postman 可基于文档生成 Mock Server,前端无需等真实接口即可联调。
- **文档即契约**:把 `10.yaml` 纳入版本管理,接口变更时有据可查。
- **鉴权占位**:调试时把 `appKey` 换成你的真实值([AppKey 管理页](https://www.showapi.com/console#/myApp)),不要硬编码进共享文档。
## FAQ
**Q:文档覆盖哪些接入点?**
A:覆盖 apiCode=10 的全部接入点,即 10-1(PDF文件正文抽取)。
**Q:能生成多种语言的 SDK 吗?**
A:OpenAPI 文档可被多种代码生成器消费(如 openapi-generator),具体生成能力取决于你选用的工具链。
**Q:文档和页面参数表不一致以谁为准?**
A:以官方接口文档与 OpenAPI 文档为准;如发现出入,以接口详情页与帮助手册为权威来源。
**Q:可以用其他 API 工具导入吗?**
A:只要是支持 OpenAPI 3.0 的工具(如 Postman / Swagger UI / Swagger Editor 等)都可导入本文档;选择你团队已在用的即可。
## 相关能力 / 下一步阅读
- [PDF文件正文抽取:通过 MCP 在 AI 客户端直接调用](https://www.showapi.com/guides/pdf-extract-mcp-10)
- [PDF文件正文抽取:5 分钟从注册到跑通第一条抽取结果](https://www.showapi.com/guides/pdf-extract-quickstart-10)
- **本系列共 10 篇**:查看[PDF文件正文抽取指南总目录](https://www.showapi.com/guides/pdf-extract-guides-10)