ruoyi前后端分离接口

### 关于 RuoYi 项目前后端分离的 API 接口文档 #### 获取用户信息接口示例 为了获取用户的详细信息，在 `RuoYi` 中定义了一个 RESTful API 来处理这类请求。该接口通常位于 `/profile/getInfo` 路径下，采用 GET 方法访问。 ```json { "msg": "操作成功", "code": 200, "data": { "userId": 1, "deptId": 103, "userName": "admin", "nickName": "管理员", "email": "[email protected]", "phonenumber": "15888888888", "sex": "1", "avatar": "", "password": null, "status": "0", "delFlag": "0", "loginIp": "127.0.0.1", "loginDate": "2021-09-14T14:20:37.000+00:00", "createBy": "admin", "createTime": "2021-08-10T06:28:43.000+00:00", "updateBy": "admin", " updateTime ": "2021-09-14T14:20:37.000+00:00 ", "remark": null, "roleId": [ 1, 2 ], "postIds": [], "role": [ { "roleId": 1, "roleName": "超级管理员", "roleKey": "admin" }, { "roleId": 2, "roleName": "普通角色", "roleKey": "common" } ] } } ``` 此响应体包含了用户的基本属性以及关联的角色列表等数据[^2]。 #### 登录认证接口说明 登录功能通过 POST 请求发送至 `/login` 地址来实现身份验证。客户端需提交用户名 (`username`) 和密码 (`password`) 参数给服务器进行校验。如果凭证有效，则返回包含 JWT Token 的 JSON 对象供后续调用其他受保护资源时作为授权依据使用。 ```http POST /login HTTP/1.1 Host: localhost:8080 Content-Type: application/json;charset=UTF-8 Cache-Control: no-cache { "username":"admin", "password":"admin123" } ``` 一旦登录成功，服务端会回应如下结构的数据： ```json { "token": "eyJhbGciOiJIUzI1NiJ9..." } ``` 上述 token 字段即为生成好的 JWT 认证令牌[^4]。 #### 文件上传接口实例 对于文件类型的上传需求，`RuoYi` 提供了专门设计的接口支持多部分表单形式(`multipart/form-data`)的内容传递。具体来说就是向路径为 `/tool/file/upload` 发起带有附件字段(file) 的 POST 请求即可完成整个过程。 ```http POST /tool/file/upload HTTP/1.1 Host: localhost:8080 Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="file"; filename="example.txt" Content-Type: text/plain < file content > ------WebKitFormBoundary7MA4YWxkTrZu0gW-- ``` 当一切顺利的话，预期得到的结果将是类似于下面这样的反馈消息： ```json {"msg":"success","code":200,"data":"/profiles/2021/09/example_1631612400000.txt"} ``` 这里 data 属性指明了所上传文件最终存储的位置链接[^3]。