导入 OpenAPI 文档:用 Apifox/Postman 管理黄历运势接口
黄历运势OpenAPIApifox接口治理Postman # 导入 OpenAPI 文档:用 Apifox/Postman 管理黄历运势接口
> 接口 黄历运势(apiCode=856) · 免费服务 · 适用人群:注重 API 治理的团队 · 阅读时间约 5 分钟
## TL;DR
- 黄历运势提供**接口级 OpenAPI 3.0 文档**,覆盖全部三个接入点。
- 文档提供 YAML 与 JSON 两种格式,可直接导入 Apifox / Postman / Swagger UI,或供 AI Agent 消费。
- 导入后即可自动生成请求模板、Mock 与参数说明,省去手填接口地址。
## Why:为什么要用 OpenAPI 管理
当你的团队把黄历运势接入多个项目,或需要联调、出 Mock、做接口审计时,一份标准的 OpenAPI 文档能统一「接口长什么样」的认知,避免每个人各写一份参数说明。本文讲清如何获取并导入。
## What:OpenAPI 文档事实(来自接口文档)
| 项目 | 内容 |
|------|------|
| 集成级别 | 接口级(覆盖 856 全部接入点) |
| 规范 | OpenAPI 3.0 |
| YAML 在线/下载 | `https://www.showapi.com/openapi/market/856.yaml` |
| JSON 查看 | `https://www.showapi.com/openapi/market/856.json` |
| 适用工具 | Apifox / Postman / Swagger UI / AI Agent |
## How:下载并导入
### 步骤 1:获取文档
直接访问(或在终端下载):
```bash
# 下载 YAML
curl -O "https://www.showapi.com/openapi/market/856.yaml"
# 或下载 JSON
curl -O "https://www.showapi.com/openapi/market/856.json"
```
### 步骤 2:导入工具
- **Apifox**:项目内「导入」→ 选择 `856.yaml` → 自动生成三个接入点的请求与参数说明。
- **Postman**:Import → 选文件 → 生成 Collection。
- **Swagger UI**:`File → Import URL` 填 `https://www.showapi.com/openapi/market/856.yaml`。
导入后即可看到 `ymd` 必填、`appKey` 鉴权等参数定义,以及各接入点地址(856-2/856-3/856-4)。
### 步骤 3:生成 Mock / 出参校验
OpenAPI 含返回结构定义,可在 Apifox 中一键 Mock,前端联调时不必等真实接口;也可在流水线里做「返回字段是否符合 schema」的契约校验。
## 进阶 / 边界
- **接口级而非接入点级**:一份文档覆盖全部接入点,导入后会在同一项目下展开多个请求。
- **与 MCP 互补**:OpenAPI 适合「人/工具治理」,MCP 适合「AI 客户端直接调用」,二者面向不同场景(见 [MCP 集成](https://www.showapi.com/guides/huangli-mcp-integration-856))。
- **鉴权字段**:OpenAPI 中 `appKey` 以 query 参数形式出现,调用时记得填入你的真实 AppKey。
## FAQ
**Q1:YAML 和 JSON 用哪个?**
A:内容一致,按你的工具偏好选;Apifox/Postman/Swagger 都支持 YAML。
**Q2:文档会自动随接口更新吗?**
A:文档由 ShowAPI 维护,更新频率以官方为准;如接口有变更,建议重新下载最新版。
**Q3:能用于代码自动生成(如 openapi-generator)吗?**
A:标准 OpenAPI 3.0 可被 openapi-generator 等工具消费生成客户端代码,但具体生成结果取决于工具对 ShowAPI 扩展字段的支持。
## 相关能力 / 下一步阅读
- [通过 MCP 在 AI 客户端直接调用黄历运势](https://www.showapi.com/guides/huangli-mcp-integration-856) —— AI 场景的另一种集成。
- [5 分钟接入黄历运势:从注册到第一条黄历数据](https://www.showapi.com/guides/huangli-quickstart-856) —— 最小可用调用。
- [黄历运势返回字段全解:黄历/吉神凶煞/吉时字段一文读懂](https://www.showapi.com/guides/huangli-response-fields-856) —— 字段语义对照。
- **本系列共 11 篇**:查看[黄历运势指南总目录](https://www.showapi.com/guides/huangli-guides-856)