首页
/ PokéAPI OpenAPI 规范详解:全面解析宝可梦数据接口

PokéAPI OpenAPI 规范详解:全面解析宝可梦数据接口

2025-07-08 05:35:14作者:龚格成

什么是PokéAPI?

PokéAPI是一个完全免费的RESTful API,提供了宝可梦主系列游戏中所有相关数据的访问接口。这个API涵盖了从宝可梦基本信息到树果口味等方方面面的数据,是开发宝可梦相关应用的理想数据源。

API基础信息

当前API版本为2.7.0,采用OpenAPI 3.1.0规范定义。API提供了多种认证方式,包括cookieAuth和basicAuth,同时也支持无需认证的公开访问。

核心端点解析

1. 宝可梦特性(Ability)接口

特性(Ability)是宝可梦在战斗或野外活动中提供的被动效果。每个宝可梦可能有多个潜在特性,但同一时间只能拥有一个特性。

端点:

  • /api/v2/ability/ - 获取特性列表
  • /api/v2/ability/{id}/ - 获取特定特性详情

参数说明:

  • limit - 控制每页返回结果数量
  • offset - 指定结果开始的索引位置
  • q - 本地可用的名称模糊查询参数(不区分大小写)

2. 树果(Berry)相关接口

树果是小型的果实,宝可梦食用后可以恢复HP、解除异常状态、增强能力值甚至抵消伤害。

主要端点:

  • /api/v2/berry/ - 树果列表
  • /api/v2/berry/{id}/ - 特定树果详情
  • /api/v2/berry-firmness/ - 树果硬度分类
  • /api/v2/berry-flavor/ - 树果口味分类

特殊参数:

  • 所有列表接口都支持分页参数(limit/offset)
  • 本地部署时支持通过q参数进行名称模糊查询

3. 宝可梦特征(Characteristic)接口

特征表示宝可梦哪项个体值(IV)最高,由最高IV除以5的余数(gene_modulo)决定。

端点:

  • /api/v2/characteristic/ - 特征列表
  • /api/v2/characteristic/{id}/ - 特定特征详情

4. 华丽大赛(Contest)相关接口

华丽大赛类型是评委用来评估宝可梦状态的分类,而大赛效果则指招式在华丽大赛中使用时的效果。

主要端点:

  • /api/v2/contest-type/ - 大赛类型列表
  • /api/v2/contest-effect/ - 大赛效果列表
  • 对应的/{id}/端点获取详情

5. 蛋群(Egg Group)接口

蛋群决定了哪些宝可梦可以互相繁殖,一个宝可梦可能属于一个或两个蛋群。

端点:

  • /api/v2/egg-group/ - 蛋群列表
  • /api/v2/egg-group/{id}/ - 特定蛋群详情

6. 遭遇方法(Encounter Method)接口

遭遇方法描述了玩家在野外遇到宝可梦的方式,例如在草丛中行走等。

端点:

  • /api/v2/encounter-method/ - 遭遇方法列表

数据结构说明

API返回的数据结构主要分为两类:

  1. 分页列表结构(PaginatedXXXSummaryList)
  2. 详情结构(XXXDetail)

所有列表接口都遵循统一的分页规范,使用limit和offset参数控制分页行为。

使用建议

  1. 对于需要大量数据的应用,合理使用分页参数可以提高性能
  2. 本地部署时可以充分利用q查询参数进行模糊搜索
  3. 所有端点都支持通过ID或名称访问资源
  4. 响应数据格式统一为JSON,便于前端处理

总结

PokéAPI通过这套OpenAPI规范,为开发者提供了全面、规范的宝可梦数据访问接口。无论是开发游戏、工具还是数据分析应用,都可以通过这些接口获取所需的宝可梦相关信息。API设计遵循RESTful原则,结构清晰,易于集成。