凌鲨本地接口架构
文章目录
本地API通过监听本地端口,提供http服务,让本地应用可以获取信息和操作凌鲨客户端。
本地API架构
flowchart LR
subgraph desktop
localapi
localapi_debug
end
subgraph extern
vscode
event_analyse
end
localapi -.- vscode
localapi -.- event_analyse启动流程
flowchart LR
start["启动凌鲨客户端"]
check_file{{"检查~/.linksaas/local_api是否存在"}}
remove_file["删除~/.linksaas/local_api文件"]
create_file["创建~/.linksaas/local_api文件"]
listen_net["监听网络"]
read_file["读取~/.linksaas/local_api"]
send_hello["发送hello请求"]
send_show["发送show指令"]
exit["退出启动过程"]
success["完成启动凌鲨客户端"]
start-->check_file--->|文件存在|read_file-->send_hello--->|成功|send_show--->|成功|exit
check_file--->|文件不存在|listen_net
send_hello--->|失败|listen_net
send_show--->|失败|listen_net
listen_net--->remove_file--->create_file--->success本地接口
全局接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/hello | GET | 握手协议 |
| http://localhost:8001/project | GET | 获取项目列表 |
| http://localhost:8001/show | GET | 显示桌面 |
微应用相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/minapp | GET | 列出已安装微应用 |
| http://localhost:8001/minapp/{minappId} | GET | 打开指定微应用 |
任务相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/project/{projectId}/task/all | GET | 列出所有任务 |
| http://localhost:8001/project/{projectId}/task/my | GET | 列出指派给我的任务 |
| http://localhost:8001/project/{projectId}/task/record/{taskId}/depend | GET | 列出依赖任务 |
| http://localhost:8001/project/{projectId}/task/record/{taskId}/events | GET | 获取任务相关事件 |
| http://localhost:8001/project/{projectId}/task/record/{taskId}/shortNote | GET | 打开桌面便签 |
| http://localhost:8001/project/{projectId}/task/record/{taskId}/show | GET | 显示任务 |
| http://localhost:8001/project/{projectId}/task/record/{taskId}/subTask | GET | 列出子任务 |
缺陷相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/project/{projectId}/bug/all | GET | 列出所有缺陷 |
| http://localhost:8001/project/{projectId}/bug/my | GET | 列出指派给我的缺陷 |
| http://localhost:8001/project/{projectId}/bug/record/{bugId}/events | GET | 获取缺陷相关事件 |
| http://localhost:8001/project/{projectId}/bug/record/{bugId}/shortNote | GET | 打开桌面便签 |
| http://localhost:8001/project/{projectId}/bug/record/{bugId}/show | GET | 显示缺陷 |
项目事件相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/project/{projectId}/event | GET | 列出项目事件 |
| http://localhost:8001/project/{projectId}/event | POST | 上传自定义事件 |
代码评论相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/project/{projectId}/codeComment/{commentThreadId} | GET | 列出代码评论 |
| http://localhost:8001/project/{projectId}/codeComment/{commentThreadId} | PUT | 新增代码评论 |
| http://localhost:8001/project/{projectId}/codeComment/{commentThreadId}/{commentId} | DELETE | 删除代码评论 |
| http://localhost:8001/project/{projectId}/codeComment/{commentThreadId}/{commentId} | GET | 获取单个代码评论 |
| http://localhost:8001/project/{projectId}/codeComment/{commentThreadId}/{commentId} | POST | 更新单个代码评论 |
GitHook相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/project/{projectId}/tools/postHook | GET | git post commit hook回调 |
内容入口相关接口
| url | 方法 | 备注 |
|---|---|---|
| http://localhost:8001/project/{projectId}/entry/show/{entryId} | GET | 打开内容入口 |
| http://localhost:8001/project/{projectId}/entry/{folderId} | GET | 列出内容目录和入口 |
调试本地接口
在系统托盘区,右键点击凌鲨图标, 选择 本地接口菜单,就可以打开 本地接口调试 页面。

评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论