跳到主要内容

通过 http接口

您也可以直接通过 http api 直接访问所有数据。 这些api与sdk是完全对等的(因为sdk是用api生成的),而正式场景中几乎都会通过sdk来使用,故此处仅做一些概念上引导。 如果SDK暂时不能满足需要,则可以考虑使用。

目前我们的文档还很薄弱,欢迎补充!

数据结构

逻辑上的存储接口是树形的:

  • repo(应用
    • rev1(版本
      • file(文件
        • function
        • function ctx
        • class
        • ...
    • rev2
      • file
        • function
        • function ctx
        • class
        • ...

一般来说:

  • 你需要以仓库、版本、文件,来查询信息
  • 但也开放了部分接口以提供全局维度的查询能力

接口一览

在部署后,你可以直接打开 http://127.0.0.1:9876/ops/swagger/index.html#/ 查看接口文档。

常见接口

通常你只需要关注五个接口:

  • /repo:用于查询当前一共有哪些代码仓
  • /rev:用于查询指定代码仓名下的版本
  • /file:查询特定仓特定版本下的文件列表
  • /func:函数信息查询
  • /funcctx:函数信息及上下文查询