咨询GitHub代码搜索API的适用文档、端点及查询参数

API端点说明 #

GET /search/code 和 GET /search?q=...&type=code 功能完全等效，前者是专门的代码搜索端点，语义更清晰，推荐优先使用。

场景1：指定仓库内搜索 #

• 查询构造：在q参数中组合关键词 + repo:<用户名/仓库名>限定符
• 请求示例：

  GET /search/code?q=payment+repo:stripe/stripe-python
  

• 说明：repo:限定符精准锁定单个仓库，格式必须是「用户名/仓库名」

场景2：指定组织内搜索 #

• 查询构造：在q参数中组合关键词 + org:<组织名>限定符
• 请求示例：

  GET /search/code?q=oauth+org:google
  

• 说明：org:限定符会覆盖该组织下所有仓库（授权后可访问私有仓库）

场景3：全GitHub平台搜索 #

• 查询构造：q参数直接传入关键词即可，无需额外限定符
• 请求示例：

  GET /search/code?q=fastapi+async
  

• 说明：默认搜索所有公开仓库，携带有效授权令牌时，会包含你有权限访问的私有仓库

参考文档 #

• GitHub REST API 搜索模块官方文档（2022-11-28版本）
• GitHub REST API 搜索查询构造指南
• GitHub REST API 代码搜索专项文档
• GitHub 平台搜索总览
• GitHub代码搜索语法详解

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