导入 Postman / Swagger UI:用 OpenAPI 文档管理邮编区域互查接口
邮编查询邮编区域互查ShowAPI免费接口API教程 # 导入 Postman / Swagger UI:用 OpenAPI 文档管理邮编区域互查接口
> 邮编区域互查(apiCode=1917)· 免费接口 · OpenAPI 3.0 · 初级~中级开发者 · 约 7 分钟
## 核心要点
- 邮编区域互查官方提供标准 **OpenAPI 3.0 文档**(YAML + JSON),覆盖全部三个接入点。
- 可导入 **Postman / Swagger UI / Swagger Editor** 管理接口、生成请求模板与 Mock 数据,便于团队协作与 API 治理。
- 文档地址:`https://www.showapi.com/openapi/market/1917.yaml`(YAML)与 `https://www.showapi.com/openapi/market/1917.json`(JSON)。
## Why:用标准文档管好接口
团队接手一个新接口,最怕「文档散、参数靠口口相传」。OpenAPI 是行业标准描述文件,导入 API 工具后能自动生成可调用的请求模板、参数说明和 Mock,少写很多重复活。
## What:接口速览
| 项 | 说明 |
|----|------|
| 接口 | 邮编区域互查(apiCode=1917) |
| 文档格式 | OpenAPI 3.0 |
| YAML | https://www.showapi.com/openapi/market/1917.yaml |
| JSON | https://www.showapi.com/openapi/market/1917.json |
| 覆盖 | 全部三个接入点 |
## How:导入 API 工具
### 下载文档
```bash
curl -O "https://www.showapi.com/openapi/market/1917.yaml"
curl -O "https://www.showapi.com/openapi/market/1917.json"
```
### 导入 Postman
1. 打开 Postman,选择「Import」。
2. 上传刚下载的 `1917.yaml` 或 `1917.json`。
3. Postman 会自动生成三个接入点的请求集合,填上 `appKey` 即可调试。
### 用 Swagger UI / Swagger Editor
1. 打开 Swagger UI 或 Swagger Editor。
2. 粘贴/上传 `1917.yaml` 内容。
3. 页面会渲染出可交互的接口文档,可直接「Try it out」填入参数调试。
## 返回示例与解析
OpenAPI 文档描述的是接口的请求/响应结构,导入后工具会按文档生成参数表单与示例响应。注意:文档中的字段名以官方描述为准;接入点2 邮编字段的**实际返回为 `postcode`**(见《返回字段全解》),若文档示例与实测不一致,以实测为准。
## 进阶/边界
- **工具选型**:Postman 适合团队协作与集合管理;Swagger UI/Editor 适合查看与交互调试。
- **Mock 数据**:可在工具里基于 OpenAPI 生成 Mock,做前端联调。
- **以实测为准**:文档是契约,但字段细节(如 `postcode`、未文档化 `areacode`)仍需对照真实返回。
- **文档地址为真实链接**:上面 YAML/JSON 为官方 OpenAPI 地址,非占位符。
## FAQ
**Q1:OpenAPI 文档在哪下?**
官方地址 `https://www.showapi.com/openapi/market/1917.yaml` 与 `.json`。
**Q2:支持哪些工具?**
任意兼容 OpenAPI 3.0 的工具,如 Postman、Swagger UI、Swagger Editor。
**Q3:导入后还要改什么?**
主要填 `appKey`;字段细节以实测为准。
**Q4:能生成 Mock 吗?**
能,基于 OpenAPI 在工具里生成 Mock 数据做联调。
**Q5:文档和实测字段不一致怎么办?**
以真实返回为准,并参考《返回字段全解》修正认知。
## 相关能力 / 下一步阅读
- [通过 MCP 协议在 AI 客户端直接查邮编](https://www.showapi.com/guides/postcode-mcp-1917)
- [邮编区域互查返回字段全解](https://www.showapi.com/guides/postcode-response-fields-1917)
- [邮编区域互查:5 分钟接入](https://www.showapi.com/guides/postcode-quickstart-1917)
- **本系列共 12 篇**:查看[邮编区域互查指南总目录](https://www.showapi.com/guides/postcode-guides-1917)