搜索¶
搜索接口用于在全平台范围内查找仓库、Issue 与用户。既有按对象专用接口，也有一个按 type 区分的通用接口。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| 仓库 | 按关键词搜仓库 | 搜索仓库 |
| Issue | 按关键词搜 Issue | 搜索 Issues |
| 用户 | 按关键词搜用户 | 搜索用户 |
| 通用搜索 | 用 type 指定对象，范围覆盖用户、组织、仓库、PR、Issue、提交、wiki |
根据类型搜索 |
标识方式¶
- 搜索目标由查询参数给出，没有路径参数，路径统一在
/api/v5/search下。 - 通用接口靠
type决定搜什么；专用接口的对象已固定在路径里。
常见任务¶
| 任务 | 接口 |
|---|---|
| 搜索仓库 | GET /api/v5/search/repositories |
| 搜索 Issue | GET /api/v5/search/issues |
| 搜索用户 | GET /api/v5/search/users |
| 按类型搜索 | GET /api/v5/search |
注意事项¶
- 通用接口是
GET /api/v5/search，靠type参数切换对象；需要用户、组织、PR、提交、wiki 等类型时用它，仓库/Issue/用户三类的专用接口语义更明确。 - 三个专用接口的路径是
/search/repositories、/search/issues、/search/users（复数），与通用接口只差一段路径。 - 分页与排序参数各接口不完全一致，按具体接口页的参数表传。
接口列表¶
本模块共 4 个接口。
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc