导入 Postman / Swagger:用 OpenAPI 文档管理网络搜索热词排行接口
OpenAPIPostmanSwaggerAPI治理 # 导入 Postman / Swagger:用 OpenAPI 文档管理网络搜索热词排行接口
> 接口:网络搜索热词排行(apiCode=313,覆盖 313-1/313-2 全部接入点) · 免费服务 · 集成方式 OpenAPI 3.0 · 适用人群:API 治理团队、后端开发 · 阅读时间:约 6 分钟
## 核心要点
- 官方提供标准 OpenAPI 3.0 文档,覆盖本接口全部接入点,可一键导入 API 工具。
- 用 Postman / Swagger UI 导入后,自动生成请求模板与 Mock,便于联调与团队共享。
- 文档地址:`https://www.showapi.com/openapi/market/313.yaml`(YAML)与 `.json`。
## Why:为什么要用 OpenAPI 管理
当你把多个 ShowAPI 接口纳入团队 API 资产时,一份标准 OpenAPI 文档能统一描述、自动生成可调用的请求模板、做 Mock 与契约测试,也方便 newcomer 上手。这个接口自带 OpenAPI 3.0 文档,省去手写描述的成本。
## What:文档信息
| 项目 | 地址 |
|------|------|
| OpenAPI YAML | https://www.showapi.com/openapi/market/313.yaml |
| OpenAPI JSON | https://www.showapi.com/openapi/market/313.json |
| 覆盖范围 | 本接口全部接入点(313-1、313-2) |
## How:导入到 API 工具
### 方式 A · 导入 Postman
1. 打开 Postman → 左上角 `Import`。
2. 选择 `Link` 标签,粘贴 `https://www.showapi.com/openapi/market/313.yaml`,确认导入。
3. 导入后生成 313-1 / 313-2 两个请求集合;在 `appKey` 查询参数处填入你的真实 AppKey 即可发送。
### 方式 B · 用 Swagger UI 在线预览
1. 打开 Swagger Editor(或任意 Swagger UI 实例)。
2. `File → Import URL`,填入 `https://www.showapi.com/openapi/market/313.yaml`。
3. 右侧即渲染出可交互的接口文档,可直接 `Try it out` 调试。
### 方式 C · 本地生成 Mock(Swagger / 命令行)
下载 YAML 后,可用 Swagger CLI 或 Prism 启动本地 Mock 服务,前端在接口未接通时即可联调:
```bash
# 示例:用 Prism 启动 mock(需本地已安装)
npx @stoplight/prism-cli mock -o fake -p 4010 https://www.showapi.com/openapi/market/313.yaml
```
## 返回示例与解析
OpenAPI 文档已声明 `showapi_res_body` 等结构,导入后在工具里能看到字段说明;业务字段含义见[返回字段全解篇](https://www.showapi.com/guides/hotword-response-fields-313)。
## 进阶 / 边界
- **appKey 占位**:导入后 `appKey` 是查询参数占位,发送前务必替换为真实 AppKey;团队共享集合时建议用环境变量而非硬编码。
- **文档与实时返回**:OpenAPI 描述的是请求/响应结构;实时 `trend` 取值不一致问题见[趋势解读篇](https://www.showapi.com/guides/hotword-trend-313),Mock 数据可能不含该细节。
- **覆盖范围**:该文档覆盖 313 全部接入点,无需为每个接入点单独导入。
## FAQ
**Q1:导入后为什么只有一个集合?**
A1:文档按接口(apiCode=313)组织,内部含 313-1、313-2 两个接入点,都在同一集合里。
**Q2:能用 Mock 做前端联调吗?**
A2:可以,用 Swagger/Prism 等工具基于 YAML 起本地 Mock,前端无需等真实接口。
**Q3:OpenAPI 文档会随接口更新吗?**
A3:以官方维护为准;若接入点有变动,重新导入最新 YAML 即可。
**Q4:团队怎么安全共享?**
A4:用 Postman 环境变量存 AppKey,集合本身不含密钥;或统一从官方 YAML 导入,避免分叉。
**Q5:支持代码生成吗?**
A5:OpenAPI 3.0 可被多数代码生成器消费,按你用的语言/框架选择对应 generator 即可。
## 相关能力 / 下一步阅读
- [通过 MCP 在 AI 客户端(Cherry Studio/ChatBox)中直接调用网络搜索热词排行](https://www.showapi.com/guides/hotword-mcp-313)
- [5 分钟接入网络搜索热词排行:从注册到拿到第一条热搜榜](https://www.showapi.com/guides/hotword-quickstart-313)
- [网络搜索热词排行返回字段全解:name/num/level/trend 一文读懂](https://www.showapi.com/guides/hotword-response-fields-313)
- **本系列共 12 篇**:查看[网络搜索热词排行开发指南总目录](https://www.showapi.com/guides/hotword-guides-313)