如何通过Bitbucket REST API(v1.0)按文件名搜索文件

Bitbucket Server v1版本（对应5.16版本）的原生核心文件接口没有提供服务端侧直接按文件名过滤搜索的专用端点，官方公开的文件相关接口仅支持拉取指定路径下的全量文件列表，没有内置文件名匹配参数。

实际使用中可以根据你的仓库规模、实例配置选以下两种方案实现：

方案1：全量拉取文件列表后本地过滤（通用无依赖） #

这个方案适配所有v1版本的Bitbucket Server，不需要额外开启服务端功能，适合文件总量在万级以内的中小仓库。

• 调用接口：GET /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/files
• 常用参数：
  • at：可选，传入分支名、tag名或commit哈希，指定拉取对应版本的文件列表，不传默认拉取仓库默认分支
  • limit/start：分页参数，limit设置单页返回最大条目数，start设置分页偏移量
• 实现逻辑：
  1. 循环调用上述接口，遍历所有分页拿到仓库全量文件的完整路径列表
  2. 在本地代码中对路径做匹配：
     • 精确匹配文件名：对每个路径按/分割取最后一段，和目标文件名做全等判断
     • 模糊匹配：直接对完整路径字符串做关键词匹配，可同时命中路径、文件名符合规则的文件
• 请求示例：

# 拉取TESTPROJ项目下demo-repo仓库默认分支的第一页文件列表
curl -u <你的用户名>:<你的访问密码/个人令牌> "http://<你的Bitbucket实例地址>/rest/api/1.0/projects/TESTPROJ/repos/demo-repo/files?limit=1000"

方案2：调用搜索接口做服务端匹配（适合大仓库） #

如果你的Bitbucket实例管理员开启了全局搜索索引服务，可以直接调用搜索接口做服务端侧的文件名检索，不需要拉取全量文件列表，性能更优，适合十万级以上文件的大仓库。

• 调用接口：GET /rest/search/1.0/search
• 常用参数：
  • query：搜索语法，文件名搜索传filename:<你要找的文件名关键词>即可
  • repository：可选，传入格式为<项目key>/<仓库slug>，限定搜索范围在指定仓库内，不传会搜索你有权限的所有仓库
• 请求示例：

# 在指定仓库内搜索文件名包含config的文件
curl -u <你的用户名>:<你的访问密码/个人令牌> "http://<你的Bitbucket实例地址>/rest/search/1.0/search?query=filename:config&repository=TESTPROJ/demo-repo"

注意：如果调用搜索接口返回404，说明实例未开启搜索索引服务，只能使用方案1实现。

内容的提问来源于stack exchange，提问作者erdem