Appearance
开放 API
对外与对内 HTTP 能力:平台 Controller + 接口引擎自定义路由。
功能说明
前缀:/api/{code}/v1(以及接口表中的自定义 route)。
| 方法 | 路由 | 名称 |
|---|---|---|
| POST | /api/code/v1/login | 账号登录 |
| GET | /api/code/v1/departmenu/context | 部门组织 |
| GET | /api/code/1/tool | 雪花生成 |
| GET | /api/code/v1/spaces | 文档空间 |
| GET | /api/code/v1/user | 我的资料 |
| GET | /api/code/v1/department/users | 部门成员 |
| DELETE | /api/code/v1/deparment/{deparment_id}/user/{user_id} | 移除成员 |
| GET | /api/code/v1/file/{id} | 下载地址 |
| POST | /api/code/v1/department/{department_id}/users | 加入部门 |
| GET | /api/code/v1/folder/content | 目录列表 |
| POST | /api/code/v1/file | 文件上传 |
| GET | /api/code/v1/role/{role_id}/users | 角色成员 |
| GET | /api/code/v1/user-roles | 我的角色 |
| GET | /api/v1/smart-link/wx/qrcode | 扫码登录 |
| GET | /api/v1/smart-link/wechat/status | 扫码状态 |
| GET | /api/v1/code/ribbon | 插件配置 |
| GET | /api/crm/v1/users | 全部用户 |
| GET | /api/code/v1/audit-logs | 审计日志 |
| GET | /api/code/v1/audit-log/{id} | 审计详情 |
| GET | /api/code/v1/error-logs | 错误日志 |
| GET | /api/code/v1/error-log/{id} | 错误详情 |
| GET | /api/code/v1/authorization-logs | 登录日志 |
| GET | /api/code/v1/authorization-log/{id} | 登录详情 |
| POST | /api/code/v1/message/test-send-site | 站内测试 |
| POST | /api/code/v1/message/test-send-email | 邮件测试 |
| POST | /api/code/v1/message/test-send-sms | 短信测试 |
| GET | /api/code/v1/message | 消息角标 |
| GET | /api/code/v1/messages | 消息面板 |
| GET | /api/code/v1/message/{id} | 标记已读 |
| GET | /api/code/v1/space/manage/list | 空间管理列表 |
原理
平台 API 经 Controller→Logic;自定义 API 经接口引擎脚本。均需鉴权(除非匿名)。
名词解释
| 名词 | 说明 |
|---|---|
| Bearer | JWT 访问令牌 |
| 站点码 |
属性说明
| 来源 | 如何扩展 |
|---|---|
| Controller | 加 Action + Logic |
| 接口引擎 | 加 t_interface 行 |
示例
http
GET /api/code/v1/user
Authorization: Bearer <token>