调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/repository/nav/references
表1 路径参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| repository_id | 是 | Integer | 参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 默认取值: 不涉及。 取值范围: 1~2147483647 |
表2 Query参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| path | 否 | String | 参数解释: 文件路径。 取值范围: 字符串长度不少于1,不超过100000。 |
| revision | 否 | String | 参数解释: 版本提交id 取值范围: 不涉及 |
| ref | 否 | String | 参数解释: 引用,可以是分支名称、标签名称或者commitid,如果不传则为默认分支。 取值范围: 字符串长度不少于1,不超过2000。 |
| symbol | 是 | String | 参数解释: 搜索符号(页面选中的字符串) 取值范围: 不涉及 |
| language | 是 | String | 参数解释: 代码语言 取值范围: -
C -
C++ -
Go -
Java -
JavaScript -
PHP -
Python -
Ruby -
Rust |
| blob | 是 | String | 参数解释: blob文件ID。通过查询某个仓库的文件信息接口查询某个仓库的文件信息获取。 取值范围: 不涉及。 |
| file_path | 是 | String | 参数解释: 文件路径。 取值范围: 字符串长度不少于1,不超过10000。 |
响应参数
状态码:200
表4 响应Body参数 | 参数 | 参数类型 | 描述 |
| result | String | 参数解释: 结果标识。 约束限制: 不涉及。 |
| message | String | 参数解释: 结果消息。 约束限制: 不涉及。 |
| defs | Array of DefEntryDto objects | 参数解释: def信息。 约束限制: 不涉及。 |
| refs | Array of RefEntryDto objects | 参数解释: 代码导航定义相关信息 |
表5 DefEntryDto | 参数 | 参数类型 | 描述 |
| tag_name | String | 参数解释: 标记名称。 约束限制: 不涉及。 |
| file_path | String | 参数解释: 文件路径。 约束限制: 不涉及。 |
| blob | String | 参数解释: blob文件ID。 约束限制: 不涉及。 |
| line_image | String | 参数解释: 索引行简要内容。 约束限制: 不涉及。 |
| line_number | Integer | 参数解释: 行号。 约束限制: 不涉及。 |
| range | String | 参数解释: 范围信息。 约束限制: 不涉及。 |
| syntax_type | String | 参数解释: 语法类型。 约束限制: 不涉及。 |
| revision | String | 参数解释: 所在版本号(commit id)。 约束限制: 不涉及。 |
| extend | String | 参数解释: 其他信息。 约束限制: 不涉及。 |
表6 RefEntryDto | 参数 | 参数类型 | 描述 |
| tag_name | String | 参数解释: 标记名称。 约束限制: 不涉及。 |
| file_path | String | 参数解释: 文件路径。 约束限制: 不涉及。 |
| blob | String | 参数解释: blob文件ID。 约束限制: 不涉及。 |
| line_image | String | 参数解释: 索引行简要内容。 约束限制: 不涉及。 |
| line_number | Integer | 参数解释: 行号。 约束限制: 不涉及。 |
| syntax_type | String | 参数解释: 语法类型。 约束限制: 不涉及。 |
| revision | String | 参数解释: 所在版本号(commit id)。 约束限制: 不涉及。 |
| extend | String | 参数解释: 其他信息。 约束限制: 不涉及。 |
响应示例
状态码:200
OK
{
"result" : "0",
"message" : "",
"defs" : [ ],
"refs" : [ {
"tag_name" : "ObjectMapper",
"file_path" : "Test.java",
"blob" : "69db78cd4b81ebxxxx38149771852e7f7da71",
"line_image" : "import com.fasterxml.jackson.databind.ObjectMapper;",
"line_number" : 10,
"syntax_type" : "variable",
"revision" : "23af980a1xxxxc1d3c9e4b8e3f25ba5c9c3aa",
"extend" : ""
}, {
"tag_name" : "ObjectMapper",
"file_path" : "Test2.java",
"blob" : "69db78cd4b81eb82f214838149771852e7f7da71",
"line_image" : " private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();",
"line_number" : 26,
"syntax_type" : "variable",
"revision" : "23af980a11c1xxxxd3c9e4b8e3f25ba5c9c3aa",
"extend" : ""
} ]
}