导入 OpenAPI 文档管理全球IP地址查询接口

# 导入 OpenAPI 文档管理全球IP地址查询接口 > 元信息：接口 全球IP地址查询（apiCode=20）· OpenAPI 集成 · 免费 · 适用人群 API 治理/后端 · 阅读时间 5 分钟 ## TL;DR 快速概览 - ShowAPI 为该接口提供标准 **OpenAPI 3.0** 文档，覆盖全部接入点（20/1、20/2）。 - 下载 YAML/JSON 后，可导入 Apifox / Postman / Swagger UI，或供 AI Agent 直接消费。 - 文档地址：`https://www.showapi.com/openapi/market/20.yaml`（YAML）与 `https://www.showapi.com/openapi/market/20.json`（JSON）。 ## Why：为什么要用 OpenAPI 管接口 当团队有多个服务、要统一做 Mock、自动化测试、代码生成或文档站时，一份机器可读的 OpenAPI 文档比散落的文章更可靠。全球IP地址查询自带 OpenAPI 3.0，导入工具即可自动生成请求模板，省去手写参数表。 ## What：OpenAPI 资源事实 | 项 | 内容 | |----|------| | 规范 | OpenAPI 3.0 | | 覆盖范围 | 本接口全部接入点（20/1、20/2） | | YAML | https://www.showapi.com/openapi/market/20.yaml | | JSON | https://www.showapi.com/openapi/market/20.json | | 用途 | 导入 Apifox / Postman / Swagger UI，或供 AI Agent 消费 | ## How：导入到常用工具 **下载文档** ```bash curl -O https://www.showapi.com/openapi/market/20.yaml curl -O https://www.showapi.com/openapi/market/20.json ``` **Apifox / Postman / Swagger UI** - Apifox：项目 → 导入 → 选择 `20.yaml` → 自动生成接口与 Mock。 - Postman：Import → 选择 `20.yaml`/`20.json` → 生成请求集合。 - Swagger UI：把 `20.yaml` 作为 `url` 参数加载即可在线浏览。 **用 openapi-python-client 生成 SDK（示例）** ```bash pip install openapi-python-client openapi-python-client generate --url https://www.showapi.com/openapi/market/20.yaml ``` > 具体生成命令与产物结构以所用工具版本为准；生成后仍需把 `appKey` 作为鉴权参数传入。 ## 返回示例与解析 OpenAPI 文档描述的是 `20-1`/`20-2` 的请求与 `showapi_res_body` 返回结构，字段含义与[返回字段全解](https://www.showapi.com/guides/ip-geo-response-fields-20)一致。导入后工具会自动列出 `ip`/`domain` 等必填参数与返回示例。 ## 进阶 / 边界 - **鉴权参数**：接口用 Query `appKey` 鉴权，导入后记得在工具里把 `appKey` 设为环境变量，勿硬编码进文档。 - **文档表字段遗漏**：正如[返回字段全解](https://www.showapi.com/guides/ip-geo-response-fields-20)指出，页面返回体表格漏列 `continents`/`en_name`/`en_name_short`；若 OpenAPI 也未包含，可在工具里手动补字段说明。 - **坐标系未声明**：`lnt`/`lat` 文档未说明坐标系，做 Mock/示例时标注"近似位置"。 ## FAQ **Q1：OpenAPI 覆盖两个接入点吗？** A：是，文档覆盖本接口全部接入点（20/1 IP查询、20/2 域名查询），一次导入即可管理两个。 **Q2：YAML 和 JSON 用哪个？** A：两者内容一致，YAML 更适合人读与版本管理，JSON 更适合程序消费，按工具要求选。 **Q3：能生成各语言 SDK 吗？** A：可用 openapi-python-client、OpenAPI Generator 等基于该文档生成客户端骨架；生成后补上 `appKey` 鉴权即可。 **Q4：文档会和接口不同步吗？** A：官方维护；若发现页面返回字段与 OpenAPI 不一致（如缺失字段），以接口实际返回为准并向官方反馈。 ## 相关能力 / 下一步阅读 - [通过 MCP 在 AI 客户端直接查询 IP 归属地](https://www.showapi.com/guides/ip-geo-mcp-20) — 另一种集成 - [5 分钟接入全球IP地址查询](https://www.showapi.com/guides/ip-geo-quickstart-20) — 代码直连 - [全球IP地址查询：返回字段全解](https://www.showapi.com/guides/ip-geo-response-fields-20) — 字段含义 - **本系列共 10 篇**：查看[全球IP地址查询指南总目录](https://www.showapi.com/guides/ip-geo-guides-20)