技术博客
地区新闻接口 OpenAPI 导入:用 Postman / Swagger UI 管理接口

地区新闻接口 OpenAPI 导入:用 Postman / Swagger UI 管理接口

作者: 万维易源
2026-09-01
地区新闻接口OpenAPIPostmanSwagger
# 地区新闻接口 OpenAPI 导入:用 Postman / Swagger UI 管理接口 > 接口/接入点:地区新闻接口(apiCode 170)· 接口级 OpenAPI 3.0|免费 · 适用人群:注重 API 治理的团队 · 阅读时间:约 5 分钟 ## 核心要点 - 官方提供标准 OpenAPI 3.0 文档,覆盖本接口全部接入点,可下载 YAML / 查看 JSON。 - 导入 **Postman / Swagger UI / Swagger Editor** 即可自动生成请求模板与 Mock 数据,便于团队协作与接口治理。 - 本文统一以 **Postman / Swagger UI / Swagger Editor** 系列表述,不引入其他 API 工具品牌。 ## Why:把接口文档变成"可执行的协作资产" 手写调用容易出错、也难和团队同步。OpenAPI 文档能一次性生成可调试的请求模板、参数说明和 Mock,前端、测试、后端看的是同一份事实来源。本文教你三分钟把官方 YAML 接进常用工具。 ## What:OpenAPI 资源 | 资源 | 地址 | |------|------| | OpenAPI 3.0 YAML(在线/下载) | https://www.showapi.com/openapi/market/170.yaml | | OpenAPI 3.0 JSON | https://www.showapi.com/openapi/market/170.json | 文档覆盖本接口全部接入点(170-47 根据地区查询新闻、170-48 区域查询)。 ## How:导入到常用工具 ### 方式 1:Swagger UI / Swagger Editor 1. 打开 Swagger Editor(或任意 Swagger UI 实例)。 2. 选择「File → Import URL」,填入 `https://www.showapi.com/openapi/market/170.yaml`。 3. 导入后可在页面直接展开各接入点,填写 `appKey` 与参数发起调试,并自动生成示例响应。 ### 方式 2:Postman 1. 下载 YAML 到本地:`curl -O https://www.showapi.com/openapi/market/170.yaml` 2. Postman 中选择「Import → File」,选中下载的 `170.yaml`。 3. Postman 会自动生成两个接入点的请求集合,补全 `appKey` 即可发送;可用其 Mock Server 能力生成模拟响应供前端联调。 ### 方式 3:Swagger Editor 本地(可选) ```bash # 用 npx 快速起一个本地 Swagger Editor 查看文档 npx @redocly/cli preview https://www.showapi.com/openapi/market/170.yaml ``` ## 返回示例与解析 OpenAPI 文档本身描述的是请求/响应结构,与实际 HTTP 调用返回一致(见返回字段全解篇)。通过工具导入后,你能看到 `areaName`、`page` 等参数的类型与说明,以及 `pagebean.contentlist` 的响应模型,比手读文档更直观。 ## 进阶 / 边界 - **字段类型以官方文档/实际返回为准**:例如 `imageurls` 在文档参数表标 String,但真实返回为数组,治理时以实际返回结构落地(详见 imageurls 篇)。 - **仅做接口管理,不改线上行为**:OpenAPI 是描述层,真正的调用仍走 `route.showapi.com/170-47`、`170-48`。 - **统一工具表述**:本接口官方文档页提及可导入某竞品 API 工具,但依本指南内容规范,全文统一使用 Postman / Swagger UI / Swagger Editor,不引入其他 API 工具品牌。 ## FAQ **Q:OpenAPI 文档覆盖哪些接入点?** A:覆盖本接口全部接入点,即根据地区查询新闻(170-47)与区域查询(170-48)。 **Q:导入后还需要自己写调用代码吗?** A:工具可生成请求模板与 Mock,联调阶段基本不用手写;生产代码仍建议你按快速开始篇的可运行示例落地。 **Q:为什么只用 Postman / Swagger 系列?** A:依本指南内容规范,全系列统一使用 Postman / Swagger UI / Swagger Editor 表述,不引入其他 API 工具品牌,保持文档中性。 ## 相关能力与下一步阅读 - [地区新闻接口 MCP 集成:在 Cherry Studio / ChatBox 中直接调用](https://www.showapi.com/guides/region-news-mcp-170) - [5 分钟接入地区新闻接口:从注册到第一条地区新闻](https://www.showapi.com/guides/region-news-quickstart-170) - **本系列共 12 篇**:查看[地区新闻接口(apiCode 170)官方指南总目录](https://www.showapi.com/guides/region-news-guides-170)