技术博客
导入 Postman / Swagger:用 OpenAPI 文档管理十万个为什么 API

导入 Postman / Swagger:用 OpenAPI 文档管理十万个为什么 API

作者: 万维易源
2026-09-02
十万个为什么 APIOpenAPIPostmanSwagger接口治理
# 导入 Postman / Swagger:用 OpenAPI 文档管理十万个为什么 API > 接口:十万个为什么(apiCode=1706)· 集成方式:OpenAPI 3.0 · 免费 · 适用人群:注重 API 治理的团队 · 阅读时间:约 6 分钟 ## 核心要点 - 十万个为什么 API 提供标准 **OpenAPI 3.0** 文档,覆盖全部接入点,可下载 YAML / JSON。 - 可导入 **Postman / Swagger UI / Swagger Editor** 做接口管理、调试与 Mock,无需手写请求模板。 - 本文不涉及任何其他 API 工具,专注于上述三款官方兼容工具。 ## Why:为什么用 OpenAPI 做治理 当团队多人协作、要写接口文档、要做 Mock 联调时,一份机器可读的 OpenAPI 文档比口头约定可靠得多。下载官方 YAML,导入你习惯的工具,请求模板、参数说明、响应结构一次到位。 ## What:文档地址 | 格式 | 地址 | |------|------| | OpenAPI YAML(在线/下载) | https://www.showapi.com/openapi/market/1706.yaml | | OpenAPI JSON | https://www.showapi.com/openapi/market/1706.json | 文档覆盖列表(1706-1)与详情(1706-2)两个接入点。 ## How:导入到常用工具 **方式 A — Postman** 1. 打开 Postman,选择「Import」。 2. 粘贴 YAML 地址 `https://www.showapi.com/openapi/market/1706.yaml` 或上传下载的文件。 3. 导入后自动生成两个接入点的请求集合,填上 `appKey` 即可调试。 **方式 B — Swagger UI** 1. 本地或线上打开 Swagger UI。 2. 在顶部输入框填入 `https://www.showapi.com/openapi/market/1706.yaml`。 3. 页面即渲染出可交互的接口文档,可直接「Try it out」。 **方式 C — Swagger Editor** 1. 打开 Swagger Editor。 2. 将 YAML 内容粘贴进左侧编辑区(或 `File → Import URL` 填上述地址)。 3. 右侧实时预览文档,便于二次注释后归档到团队知识库。 ## 返回示例与解析 OpenAPI 文档中的 `paths` 包含 `/1706-1`(列表)与 `/1706-2`(详情),各自的 `parameters`(如 `keyword`、`id`)与 `responses` 结构,与接口实际返回一致,可作为生成客户端代码的依据。 ## 进阶 / 边界 - **appKey 处理**:OpenAPI 文档通常把 `appKey` 作为 query 参数描述,调试时在对应位置填入你的真实 AppKey(来自 [AppKey 管理](https://www.showapi.com/console#/myApp))。 - **Mock 联调**:在 Postman / Swagger 中可基于 schema 生成 Mock 响应,前端提前联调,不消耗免费档位。 - **文档与实接口一致**:以官方 YAML 为准;如发现问题以接口实际返回为权威。 ## FAQ **Q1:YAML 和 JSON 用哪个?** 两者内容一致,Postman / Swagger 都支持;习惯文本编辑用 YAML,程序解析用 JSON。 **Q2:导入后还要自己填参数吗?** `keyword`/`id`/`appKey` 等仍需按调用填入,文档只提供结构与示例。 **Q3:能用它自动生成 SDK 吗?** 可以,OpenAPI 生态有大量代码生成器,基于该 YAML 生成多语言客户端。 **Q4:文档覆盖两个接入点吗?** 覆盖,列表与详情都在同一份 OpenAPI 文档内。 **Q5:Mock 会消耗免费档位吗?** 不会,Mock 是工具本地基于 schema 生成,不请求真实接口。 ## 相关能力 / 下一步阅读 - [通过 MCP 在 AI 客户端直接调用十万个为什么 API](https://www.showapi.com/guides/why100k-mcp-integration-1706) - [十万个为什么 API:5 分钟接入,从第一条问答到完整详情](https://www.showapi.com/guides/why100k-quickstart-1706) - [十万个为什么 API 返回字段全解:ret_code / contentlist / content 一文读懂](https://www.showapi.com/guides/why100k-response-fields-1706) - **本系列共 11 篇**:查看[十万个为什么 API 指南总目录](https://www.showapi.com/guides/why100k-guides-1706)