跳到主要内容
版本:1.8.7

API Sitemaps

API 搜索

  • API Path/api/v1/api_route/search

  • 请求协议HTTP

  • 请求方法POST

  • 请求内容

    {
    "exclude_ids": "",
    "page_size": 1,
    "page_index": 1,
    "uri": "",
    "http_method": "",
    "is_cover": "",
    "project_id": "188",
    "version_id": 1360
    }
  • 响应内容

    {
    "status": 201,
    "msg": "success",
    "data": [
    {
    "id": 188841,
    "path": "/swagger-resources/configuration/ui",
    "code_class": "springfox.documentation.swagger.web.ApiResourceController",
    "description": "",
    "method": {
    "apimethod": "GET/POST",
    "httpmethods": [
    "GET",
    "POST"
    ]
    },
    "code_file": "",
    "controller": "springfox.documentation.swagger.web.ApiResourceController",
    "agent": 6423,
    "is_cover": 0,
    "parameters": [],
    "responses": [
    {
    "id": 29906,
    "return_type": "org.springframework.http.ResponseEntity",
    "route": 188841,
    "return_type_shortcut": "ResponseEntity"
    }
    ],
    "vulnerablities": []
    }
    ]
    }
  • 请求参数Json Object

    参数名说明必填类型值可能性限制示例
    page_size每页数量[int]
    uriApi 导航对应的 URI[string]
    http_method该 API 对应的 HTTP 方法[string]
    project_id项目 ID[int]
    version_id项目的版本 ID[int]
    exclude_ids排除以下 ID 的 API route,该字段用于分批获取整个项目的数据[string]
    is_cover表示该 API 是否被覆盖,覆盖指记录到了相关的方法调用链[string]
  • 响应内容

  • 返回结果Json Object

    参数名说明必填类型值可能性限制示例
    data[object]
    data>>idAPI 的 ID[int]
    data>>pathAPI的 URI[string]
    data>>code_class该 API 的对应类[string]
    data>>descriptionAPI 导航对应的注释[string]
    data>>code_fileAPI 导航对应的代码文件[string]
    data>>controllerAPI 导航对应的 controller[string]
    data>>agent上报该 API 的 Agent 的 ID[int]
    data>>is_cover表示该 API 是否被覆盖,覆盖指记录到了相关的方法调用链[string]
    data>>responses[array]
    data>>responses>>idAPI 响应数据的 ID[int]
    data>>responses>>return_type该 API 响应的类型[string]
    data>>responses>>route该响应的对应的 API ID[int]
    data>>responses>>return_type_shortcutreturn_type 的简称[string]
    参数名说明必填类型值可能性限制示例
    parameters[array]
    parameters>>idAPI 的 ID[int]
    parameters>>name该 API 的名称[string]
    parameters>>parameter_type参数类型[string]
    parameters>>parameter_type_shortcut参数类型缩写,如:java.lang.String -> String[string]
    parameters>>annotaion关于该参数的注释[string]
    parameters>>route该参数的对应的 API ID[int]
    参数名说明必填类型值可能性限制示例
    vulnerablities[array]
    vulnerablities>>level_id漏洞类型 ID[int]
    vulnerablities>>hook_type_name漏洞类型名称[string]
    参数名说明必填类型值可能性限制示例
    method[object]
    method>>apimethod该 API 所绑定的方法[string]
    method>>httpmethods该 API 所绑定的方法,数组形式[array]
    method>>httpmethods>>httpmethod[string]
    status状态码:201[int]
    msg状态信息:success[string]

测试覆盖率

  • API Path/api/v1/api_route/cover_rate

  • 请求协议HTTP

  • 请求方法GET

  • 详细说明: 通过指定id来获取对应项目的API覆盖率

  • 请求内容

    /api/v1/api_route/cover_rate?project_id=188&version_id=1360
  • 响应内容

    {
    "status": 201,
    "msg": "API覆盖率获取成功",
    "data": {
    "cover_rate": "3.85%"
    }
    }
  • Query 参数

    参数名说明必填类型限制示例
    project_id[int]
    version_id[int]
  • 响应内容

  • 返回结果Json Object

    参数名说明必填类型值可能性限制示例
    data[object]
    data>>cover_rate项目的 API 覆盖率[int]
    status状态码:201[int]
    msg状态信息:success[string]