如何识别应用程序或服务可访问的API版本
私有部署Bitbucket Server API版本识别方法
Bitbucket Server专属识别方法
- 直接请求元数据接口:在你的Bitbucket实例域名后拼接路径
/rest/api/1.0/application-properties,如果返回正常结构化数据说明支持1.0版本;再尝试拼接/rest/api/2.0/application-properties,返回正常即为支持2.0版本。大部分私有部署实例的元数据接口无需鉴权即可访问,权限管控严格的实例使用你的日常登录账号鉴权后请求即可。 - 后台版本匹配:进入实例的管理员后台,找到应用程序版本条目,对照官方的版本与API支持对应关系查询即可:Bitbucket Server 4.0及以上版本默认同时支持1.0和2.0版本API,7.0及以上版本开始降低1.0版本优先级,你可以直接根据实例版本匹配可用的API范围。
通用REST API版本识别方法
该方法适用于绝大多数提供REST接口的应用,不限于Bitbucket:
- 根路径请求:直接请求API的无版本前缀路径,例如目标API通用前缀为
/rest/api,直接请求该路径,符合开发规范的REST服务会直接返回支持的所有版本列表、各版本的路径前缀说明。 - 响应头校验:调用任意可访问的接口后,查看返回响应头中的
X-API-Version、Api-Supported-Versions字段,规范服务端会在响应头中明确标注当前请求使用的API版本、服务端支持的所有版本范围。 - 路径试探:按照行业通用命名规则,依次试探带版本后缀的API前缀,例如
/v1、/v2、/1.0、/2.0,返回404状态码即为不支持该版本,返回200/401/403状态码都属于支持该版本的信号。
内容的提问来源于stack exchange,提问作者Antonow297296
相关产品推荐
相关产品推荐

