获取代码导航大纲 - ShowRepositoryNavigationOutline

功能介绍

获取代码导航大纲

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

当前API调用无需身份策略权限。

URI

GET /v4/repositories/{repository_id}/repository/nav/outline

表1 路径参数
参数	是否必选	参数类型	描述
repository_id	是	Integer	参数解释：仓库的ID，通过查询用户所有仓库接口查询项目列表获取。约束限制：不涉及。默认取值：不涉及。取值范围： 1~2147483647

表2 Query参数
参数	是否必选	参数类型	描述
revision	否	String	参数解释：版本提交id 取值范围：不涉及
ref	否	String	参数解释：引用，可以是分支名称、标签名称或者commitid，如果不传则为默认分支。取值范围：字符串长度不少于1，不超过2000。
language	是	String	参数解释：代码语言取值范围： C C++ Go Java JavaScript PHP Python Ruby Rust
blob	是	String	参数解释： blob文件ID。通过查询某个仓库的文件信息接口查询某个仓库的文件信息获取。取值范围：不涉及。
file_path	是	String	参数解释：文件路径。取值范围：字符串长度不少于1，不超过10000。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：不涉及。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
result	String	参数解释：结果标识。约束限制：不涉及。
message	String	参数解释：结果消息。约束限制：不涉及。
file_path	String	参数解释：文件路径。约束限制：不涉及。
revision	String	参数解释：所在版本号（commit id）。约束限制：不涉及。
symbols	Array of SymbolNodeDto objects	参数解释：符号列表。约束限制：不涉及。

表5 SymbolNodeDto
参数	参数类型	描述
def	DefEntryDto object	参数解释：代码导航def相关信息
children	Array of SymbolNodeDto objects	参数解释：子节点信息

表6 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	参数解释：其他信息。约束限制：不涉及。

请求示例

无

响应示例

状态码：200

{
  "result" : "0",
  "message" : "",
  "file_path" : "Test.java",
  "revision" : "23af980a11c164fxxxx3c9e4b8e3f25ba5c9c3aa",
  "symbols" : [ {
    "def" : {
      "tag_name" : "JacksonUtils",
      "file_path" : "Test.java",
      "blob" : "69db78cd4b81xxx214838149771852e7f7da71",
      "line_image" : "public class JacksonUtils {",
      "line_number" : 25,
      "range" : "23-82",
      "syntax_type" : "class",
      "revision" : "23af980a11c164f9c1d3c9e4b8e3f25ba5c9c3aa",
      "extend" : ""
    },
    "children" : [ {
      "def" : {
        "tag_name" : "toJson",
        "file_path" : "Test.java",
        "blob" : "69db78cd4b81exxx838149771852e7f7da71",
        "line_image" : "public static String toJson(Object object) ",
        "line_number" : 34,
        "range" : "33-41",
        "syntax_type" : "method",
        "revision" : "23af980a11cxxxd3c9e4b8e3f25ba5c9c3aa",
        "extend" : ""
      },
      "children" : null
    }, {
      "def" : {
        "tag_name" : "fromJson",
        "file_path" : "Test.java",
        "blob" : "69db78cd4b81eb82xxx771852e7f7da71",
        "line_image" : "public static <T> T fromJson(String json,   lass<T> clazz)                 {",
        "line_number" : 51,
        "range" : "50-58",
        "syntax_type" : "method",
        "revision" : "23af980a11c164f9c1d3c9e4b8e3f25ba5c9c3aa",
        "extend" : ""
      },
      "children" : null
    }, {
      "def" : {
        "tag_name" : "fromJsonToList",
        "file_path" : "Test.java",
        "blob" : "69db78cd4b81xxx38149771852e7f7da71",
        "line_image" : "public static <T> List<T> fromJsonToList(String json,   lass<T> clazz) {",
        "line_number" : 68,
        "range" : "67-81",
        "syntax_type" : "method",
        "revision" : "23af980a11c164f9c1d3c9e4b8e3f25ba5c9c3aa",
        "extend" : ""
      },
      "children" : null
    } ]
  } ]
}