凌鲨本地接口架构

2024-03-15 13:24:04
开发
46

本地API通过监听本地端口，提供http服务，让本地应用可以获取信息和操作凌鲨客户端。

本地API架构

启动流程

本地接口

全局接口

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	列出内容目录和入口

调试本地接口

在凌鲨托盘区选择本地接口菜单，就可以打开本地接口调试页面。

在这里插入图片描述

原文地址:https://blog.csdn.net/weixin_37582237/article/details/136616956 本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：https://www.suanlizi.com/kf/1768508441665605632.html 如若内容造成侵权/违法违规/事实不符，请联系《酸梨子》网邮箱：1419361763@qq.com进行投诉反馈，一经查实，立即删除！

阅读全部