技术博客
导入 Postman / Swagger:用 OpenAPI 文档管理历史上的今天接口

导入 Postman / Swagger:用 OpenAPI 文档管理历史上的今天接口

作者: 万维易源
2026-08-31
历史上的今天OpenAPIPostmanSwagger
# 导入 Postman / Swagger:用 OpenAPI 文档管理历史上的今天接口 > 接口:历史上的今天(apiCode=119,接入点 119-42)· 免费 · 集成能力:OpenAPI 3.0 文档 · 适用人群:API 治理团队 · 阅读时间:约 5 分钟 ## 核心要点 - 官方提供标准 OpenAPI 3.0 文档(YAML / JSON),覆盖本接口全部接入点。 - 可导入 **Postman / Swagger UI / Swagger Editor**,自动生成请求模板与 Mock 数据。 - 适合做接口治理、团队协作、文档沉淀——不用手搓请求。 > 本文以 Postman / Swagger 为例。**禁止使用 Apifox**:不得编写任何以 Apifox 为主题或与之相关的文章,全文(含标题、代码注释、FAQ)不出现 "Apifox" 字样;API 工具导入/调试/Mock 场景统一用 Postman / Swagger UI / Swagger Editor 表述。 ## Why:把接口"文档化"管理 团队多人接同一个接口,最怕各写各的请求。把官方 OpenAPI 文档导入 Postman/Swagger,所有人拿到同一套请求模板、参数说明和 Mock,联调效率直接拉满,也方便后续生成在线文档。 ## What:OpenAPI 文档地址(官方) | 格式 | 地址 | |------|------| | YAML | https://www.showapi.com/openapi/market/119.yaml | | JSON | https://www.showapi.com/openapi/market/119.json | 文档为标准 OpenAPI 3.0,覆盖本接口全部接入点(本品仅 119-42)。 ## How:导入与试用 ### 方式 A:Postman 1. 打开 Postman → 左上角 **Import**。 2. 粘贴链接 `https://www.showapi.com/openapi/market/119.yaml`(或下载后用文件导入)。 3. 导入后自动生成「历史上的今天」请求集合,含参数 `date` / `needContent` 与示例。 4. 在 `appKey` 处填你的真实 AppKey(https://www.showapi.com/console#/myApp),Send 即可。 ### 方式 B:Swagger UI / Swagger Editor 1. 打开 Swagger Editor(或自托管 Swagger UI)。 2. 粘贴 YAML 内容或导入 `119.yaml`。 3. 右侧自动渲染接口文档,可在线 **Try it out** 填参调试。 4. 需要 Mock:用 Swagger 生成的 schema 在支持的工具里造样例数据,或导出 JSON Schema 给前端做类型定义。 ### 方式 C:命令行拉取(核对文档) ```bash curl -s https://www.showapi.com/openapi/market/119.yaml -o history-openapi.yaml head -n 20 history-openapi.yaml ``` ## 返回示例与解析 OpenAPI 描述的是同一个接口:POST/GET `route.showapi.com/119-42`,业务返回 `showapi_res_body.list`(字段见[返回字段篇](https://www.showapi.com/guides/history-today-response-fields-119))。导入后工具会自动按 schema 校验你的请求/响应。 ## 进阶 / 边界 - **Mock 数据仅用于联调**:Mock 出来的 `content`/`img` 是样例,真实数据以接口返回为准。 - **文档即契约**:把 OpenAPI 文件纳入仓库,接口变动时以官方更新为准,团队同步刷新。 - **appKey 不入文档**:OpenAPI 文件里不要硬编码 AppKey,用环境变量/Postman 变量管理。 ## FAQ **Q1:能用 Apifox 吗?** 本文及全系列不提供 Apifox 相关教程。请使用 Postman / Swagger UI / Swagger Editor 等工具导入 OpenAPI 文档。 **Q2:YAML 和 JSON 选哪个导入?** 两者内容等价,按你用的工具习惯选;Postman/Swagger 都支持。 **Q3:导入后参数说明不全怎么办?** 以官方接口详情页(https://www.showapi.com/apiGateway/view/119)的参数为准,OpenAPI 作为结构化补充。 **Q4:能自动生成前端类型吗?** 可以。从 OpenAPI 的 JSON Schema 导出 TypeScript 类型/客户端代码(如用 openapi-typescript 等社区工具)。 ## 相关能力 / 下一步阅读 - [通过 MCP 在 AI 客户端(Cherry Studio / ChatBox)中直接查询历史上的今天](https://www.showapi.com/guides/history-today-mcp-119) — 另一种零代码集成。 - [历史上的今天:5 分钟接入,从注册到第一条历史事件](https://www.showapi.com/guides/history-today-quickstart-119) — 直接调用。 - [历史上的今天返回字段全解:list / title / year / content / img 一文读懂](https://www.showapi.com/guides/history-today-response-fields-119) — 字段定义。 - **本系列共 10 篇**:查看[历史上的今天指南总目录](https://www.showapi.com/guides/history-today-guides-119)