tlias智能学习辅助系统接口文档-V1.0

最新推荐文章于 2024-11-25 16:57:40 发布
最新推荐文章于 2024-11-25 16:57:40 发布
阅读量1k 收藏 8
点赞数 22
分类专栏： 软件测试 文章标签： java 前端 python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/m0_62388400/article/details/142287031
版权

1. 部门管理

1.1 部门列表查询

1.1.1 基本信息

请求路径：/depts

请求方式：GET

接口描述：该接口用于部门列表数据查询

1.1.2 请求参数

无

1.1.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject[ ]非必须返回的数据
|- idnumber非必须id
|- namestring非必须部门名称
|- createTimestring非必须创建时间
|- updateTimestring非必须修改时间

响应数据样例：

{
  "code": 1,
  "msg": "success",
  "data": [
    {
      "id": 1,
      "name": "学工部",
      "createTime": "2022-09-01T23:06:29",
      "updateTime": "2022-09-01T23:06:29"
    },
    {
      "id": 2,
      "name": "教研部",
      "createTime": "2022-09-01T23:06:29",
      "updateTime": "2022-09-01T23:06:29"
    }
  ]
}

1.2 删除部门

1.2.1 基本信息

请求路径：/depts/{id}

请求方式：DELETE

接口描述：该接口用于根据ID删除部门数据

1.2.2 请求参数

参数格式：路径参数

参数说明：

参数名类型是否必须备注
idnumber必须部门ID

请求参数样例：

/depts/1

1.2.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据

响应数据样例：

{
    "code":1,
    "msg":"success",
    "data":null
}

1.3 添加部门

1.3.1 基本信息

请求路径：/depts

请求方式：POST

接口描述：该接口用于添加部门数据

1.3.2 请求参数

格式：application/json

参数说明：

参数名类型是否必须备注
namestring必须部门名称

请求参数样例：

{
    "name": "教研部"
}

1.3.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据

响应数据样例：

{
    "code":1,
    "msg":"success",
    "data":null
}

1.4 根据ID查询

1.4.1 基本信息

请求路径：/depts/{id}

请求方式：GET

接口描述：该接口用于根据ID查询部门数据

1.4.2 请求参数

参数格式：路径参数

参数说明：

参数名类型是否必须备注
idnumber必须部门ID

请求参数样例：

/depts/1

1.4.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据
|- idnumber非必须id
|- namestring非必须部门名称
|- createTimestring非必须创建时间
|- updateTimestring非必须修改时间

响应数据样例：

{
  "code": 1,
  "msg": "success",
  "data": {
    "id": 1,
    "name": "学工部",
    "createTime": "2022-09-01T23:06:29",
    "updateTime": "2022-09-01T23:06:29"
  }
}

1.5 修改部门

1.5.1 基本信息

请求路径：/depts

请求方式：PUT

接口描述：该接口用于修改部门数据

1.5.2 请求参数

格式：application/json

参数说明：

参数名类型是否必须备注
idnumber必须部门ID
namestring必须部门名称

请求参数样例：

{
    "id": 1,
    "name": "教研部"
}

1.5.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据

响应数据样例：

{
    "code":1,
    "msg":"success",
    "data":null
}

2. 员工管理

2.1 员工列表查询

2.1.1 基本信息

请求路径：/emps

请求方式：GET

接口描述：该接口用于员工列表数据的条件分页查询

2.1.2 请求参数

参数格式：queryString

参数说明：

参数名称是否必须示例备注
name否张姓名
gender否1性别 , 1 男 , 2 女
begin否2010-01-01范围匹配的开始时间(入职日期)
end否2020-01-01范围匹配的结束时间(入职日期)
page是1分页查询的页码，如果未指定，默认为1
pageSize是10分页查询的每页记录数，如果未指定，默认为10

请求数据样例：

/emps?name=张&gender=1&begin=2007-09-01&end=2022-09-01&page=1&pageSize=10

2.1.3 响应数据

参数格式：application/json

参数说明：

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 1 成功 , 0 失败
msgstring非必须提示信息
dataobject必须返回的数据
|- totalnumber必须总记录数
|- rowsobject []必须数据列表item 类型: object
|- idnumber非必须id
|- usernamestring非必须用户名
|- namestring非必须姓名
|- passwordstring非必须密码
|- entrydatestring非必须入职日期
|- gendernumber非必须性别 , 1 男 ; 2 女
|- imagestring非必须图像
|- jobnumber非必须职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
|- deptIdnumber非必须部门id
|- createTimestring非必须创建时间
|- updateTimestring非必须更新时间

响应数据样例：

{
  "code": 1,
  "msg": "success",
  "data": {
    "total": 2,
    "rows": [
       {
        "id": 1,
        "username": "jinyong",
        "password": "123456",
        "name": "金庸",
        "gender": 1,
        "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
        "job": 2,
        "entrydate": "2015-01-01",
        "deptId": 2,
        "createTime": "2022-09-01T23:06:30",
        "updateTime": "2022-09-02T00:29:04"
      },
      {
        "id": 2,
        "username": "zhangwuji",
        "password": "123456",
        "name": "张无忌",
        "gender": 1,
        "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
        "job": 2,
        "entrydate": "2015-01-01",
        "deptId": 2,
        "createTime": "2022-09-01T23:06:30",
        "updateTime": "2022-09-02T00:29:04"
      }
    ]
  }
}

2.2 删除员工

2.2.1 基本信息

请求路径：/emps/{ids}

请求方式：DELETE

接口描述：该接口用于批量删除员工的数据信息

2.2.2 请求参数

参数格式：路径参数

参数说明：

参数名类型示例是否必须备注
ids数组 array1,2,3必须员工的id数组

请求参数样例：

/emps/1,2,3

2.2.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据

响应数据样例：

{
    "code":1,
    "msg":"success",
    "data":null
}

2.3 添加员工

2.3.1 基本信息

请求路径：/emps

请求方式：POST

接口描述：该接口用于添加员工的信息

2.3.2 请求参数

参数格式：application/json

参数说明：

名称类型是否必须备注
usernamestring必须用户名
namestring必须姓名
gendernumber必须性别, 说明: 1 男, 2 女
imagestring非必须图像
deptIdnumber非必须部门id
entrydatestring非必须入职日期
jobnumber非必须职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师

请求数据样例：

{
  "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-03-07-37-38222.jpg",
  "username": "linpingzhi",
  "name": "林平之",
  "gender": 1,
  "job": 1,
  "entrydate": "2022-09-18",
  "deptId": 1
}

2.3.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据

响应数据样例：

{
    "code":1,
    "msg":"success",
    "data":null
}

2.4 根据ID查询

2.4.1 基本信息

请求路径：/emps/{id}

请求方式：GET

接口描述：该接口用于根据主键ID查询员工的信息

2.4.2 请求参数

参数格式：路径参数

参数说明：

参数名类型是否必须备注
idnumber必须部门ID

请求参数样例：

/emps/1

2.4.3 响应数据

参数格式：application/json

参数说明：

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 1 成功 , 0 失败
msgstring非必须提示信息
dataobject必须返回的数据
|- idnumber非必须id
|- usernamestring非必须用户名
|- namestring非必须姓名
|- passwordstring非必须密码
|- entrydatestring非必须入职日期
|- gendernumber非必须性别 , 1 男 ; 2 女
|- imagestring非必须图像
|- jobnumber非必须职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
|- deptIdnumber非必须部门id
|- createTimestring非必须创建时间
|- updateTimestring非必须更新时间

响应数据样例：

{
  "code": 1,
  "msg": "success",
  "data": {
    "id": 2,
    "username": "zhangwuji",
    "password": "123456",
    "name": "张无忌",
    "gender": 1,
    "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
    "job": 2,
    "entrydate": "2015-01-01",
    "deptId": 2,
    "createTime": "2022-09-01T23:06:30",
    "updateTime": "2022-09-02T00:29:04"
  }
}

2.5 修改员工

2.5.1 基本信息

请求路径：/emps

请求方式：PUT

接口描述：该接口用于修改员工的数据信息

2.5.2 请求参数

参数格式：application/json

参数说明：

名称类型是否必须备注
idnumber必须id
usernamestring必须用户名
namestring必须姓名
gendernumber必须性别, 说明: 1 男, 2 女
imagestring非必须图像
deptIdnumber非必须部门id
entrydatestring非必须入职日期
jobnumber非必须职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师

请求数据样例：

{
  "id": 1,
  "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-03-07-37-38222.jpg",
  "username": "linpingzhi",
  "name": "林平之",
  "gender": 1,
  "job": 1,
  "entrydate": "2022-09-18",
  "deptId": 1
}

2.5.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据

响应数据样例：

{
    "code":1,
    "msg":"success",
    "data":null
}

2.6 文件上传

2.6.1 基本信息

请求路径：/upload

请求方式：POST

接口描述：上传图片接口

2.6.2 请求参数

参数格式：multipart/form-data

参数说明：

参数名称参数类型是否必须示例备注
imagefile是

2.6.3 响应数据

参数格式：application/json

参数说明：

参数名类型是否必须备注
codenumber必须响应码，1 代表成功，0 代表失败
msgstring非必须提示信息
dataobject非必须返回的数据，上传图片的访问路径

响应数据样例：

{
    "code": 1,
    "msg": "success",
    "data": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-0400.jpg"
}

3. 其他接口

3.1 登录

3.1.1 基本信息

请求路径：/login

请求方式：POST

接口描述：该接口用于员工登录Tlias智能学习辅助系统，登录完毕后，系统下发JWT令牌。

3.1.2 请求参数

参数格式：application/json

参数说明：

名称类型是否必须备注
usernamestring必须用户名
passwordstring必须密码

请求数据样例：

{
	"username": "jinyong",
    "password": "123456"
}

3.1.3 响应数据

参数格式：application/json

参数说明：

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 1 成功 ; 0 失败
msgstring非必须提示信息
datastring必须返回的数据 , jwt令牌

响应数据样例：

{
  "code": 1,
  "msg": "success",
  "data": "eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoi6YeR5bq4IiwiaWQiOjEsInVzZXJuYW1lIjoiamlueW9uZyIsImV4cCI6MTY2MjIwNzA0OH0.KkUc_CXJZJ8Dd063eImx4H9Ojfrr6XMJ-yVzaWCVZCo"
}

3.1.4 备注说明

用户登录成功后，系统会自动下发JWT令牌，然后在后续的每次请求中，都需要在请求头header中携带到服务端，请求头的名称为 token ，值为 登录时下发的JWT令牌。

如果检测到用户未登录，则会返回如下固定错误信息：

{
	"code": 0,
	"msg": "NOT_LOGIN",
	"data": null
}

SpringBootWeb案例3--登录认证--登录校验--过滤器Filter
m0_59281987的博客
04-27 1553
/定义一个类，实现一个标准的Filter过滤器的接口@Override //初始化方法, 只调用一次System.out.println("init 初始化方法执行了");@Override //拦截到请求之后调用, 调用多次System.out.println("Demo 拦截到了请求...放行前逻辑");//放行@Override //销毁方法, 只调用一次System.out.println("destroy 销毁方法执行了");
JavaWeb后端阶段项目(完结散花）
2301_79291058的博客
10-19 1107
准备数据库表（dept、emp）创建springboot工程，引入对应的起步依赖（web、mybatis、mysql驱动、lombok）配置文件application.properties中引入maybatis的配置信息，准备对应的实体类准备对应的Mapper、Service（接口、实现类）、Controller基础结构导入结构controller（实体类）mapper（接口）pojo（实体类）service（接口）配置xml映射文件，编写SQL语句（在resources文件夹下新建）
黑马头条前台API 接口文档
10-30
黑马头条前台-API 接口文档：用户登录，注册，编辑关注取消，评论；新闻文章：搜索，推荐，详情，列表获取，发布，收藏，点赞，编辑，文件上传；首页栏目获取和添加
黑马官方提供的tlias智能学习辅助系统接口文档
这里有一只小马吖
07-12 2715
黑马官方提供的tlias智能学习辅助系统接口文档
SpringBootWeb案例01：tlias智能学习辅助系统
apple_51927114的博客
06-04 4548
部门管理功能开发包括。
黑马接口文档说明
lzh的博客
07-20 4368
黑马商城项目接口文档 轮播图接口 接口地址：/api/getlunbo 请求方式：GET 参数：无 数据格式： { "status":0, "message":[ { "id":1, "url":"http://www.itcast.cn/subject/phoneweb/index.html", "img":"http://m.itheima.com/images/slidead/mobile/20191213180241750x410.jpg" },
黑马前端文档
08-15
内容不错，好东西和大家共享
黑马程序员——接口测试——day01——接口测试理论、HTTP协议、接口测试流程、接口文档解析
qq_56444564的博客
02-22 2327
简介:超文本传输协议，基于请求与响应的应用层协议。特点︰客户端、服务器模式简单快速灵活无连接无状态人力资源管理系统模块:员工管理组织架构(部门管理)招聘管理考勤管理绩效管理也叫API文档，一般由后端开发工程师编写。用来描述接口信息的文档。
黑马头条后台接口API.md
10-30
黑马头条后台接口：用户登录，注册，编辑关注取消，评论；新闻文章：搜索，推荐，详情，列表获取，发布，收藏，点赞，编辑，文件上传；首页栏目获取和添加
黑马-“tlias智能学习辅助系统” 项目 复盘
一位努力搬砖的不入流程序猿
09-18 2905
学习java将近一年了，看javaweb过程中首次接触完整的前后端结合项目，看完一遍黑马的课，还有点迷糊，感觉自己什么都没学会，下面对这个项目进行一下完整的梳理和复盘。
tlias智能辅助学习系统（springboot+vue+mybatis+MySQL数据库）（源码）
10-29
tlias智能辅助学习系统 软件架构 技术栈：springboot+vue+mybatis 数据库：MySQL 软件包 前端：JavaWeb_UI 后端：JavaWeb_serve 使用说明 前端： 前端需要nginx，node 使用vscode打开JavaWeb_UI文件，进入项目根目录输入：npm run dev 启动 cd .\JavaWeb_UI\javaWeb_UI\ npm run dev 后端： 后端需要引入lombok， 启动类：com.example.TliasApplication 其他文件： ​ 配置文件：src/main/resources/application.properties ​ 将MySQL的url，账号，密码都改成自己的 ​ SQL文件：JavaWeb_serve/Tlias.sql
Tlias智能学习辅助系统
m0_45253972的博客
11-25 2026
通过Tlias智能学习辅助系统这个案例，将前端开发、后端开发、数据库整合起来。在这个案例中，前端开发人员已经将前端工程开发完毕了。 我们需要做的，就是参考接口文档完成后端功能的开发，然后结合前端工程进行联调测试即可。 1、需求说明 部门管理功能开发包括：查询部门列表、新增部门、删除部门、修改部门。 员工管理功能开发包括：查询员工列表(分页、条件)、新增员工、删除员工、修改员工。 2、环境搭建 步骤： 准备数据库表(dept、emp) 创建springboot工程，引入对应的起步依赖（web、myba
tlias智能学习辅助系统
xian2h的博客
01-24 2040
tlias智能学习辅助系统的设计开发
【SpringBoot】项目—TLIAS智能学习辅助系统
m0_73509988的博客
04-16 5056
TLIAS智能学习辅助系统一、Spring1、Service层DeptServiceImpl接口DeptServiceImpl实现类EmpService接口EmpService实现类2、IOC3、DI4、AOPLog自定义注解LogAspect切面类5、事务管理二、Spring MVC1、Controller层DeptControllerEmptController2、拦截器 (interceptor)LoginCheckInterceptorWebConfig3、全局异常处理三、Mybatis1、Mapp
案例01-tlias智能学习辅助系统01-增删改查+参数传递
m0_63757196的博客
04-24 7828
参数格式：路径参数使用 @PathVariable 表示绑定路径中的参数id参数格式：application/json使用：@RequestBody 将获取到的请求参数封装到实体类中eg: 请求参数是Dept类的部分属性值参数格式：queryString@RequestParam(defaultValue = "1") 设置默认值下面的参数名称和类型一定要和文档中的保持一致，否则传输不了数据。
黑马视频学习之大事件接口文档
Zm6Cc的博客
12-07 796
b站上黑马的接口文档，方便观看
java自学阶段二:JavaWeb开发70（项目实战1之黑马tlias智能学习辅助系统）
Albert_LG的博客
05-08 1710
黑马学习springboot项目：tilas在线只能辅助系统
根据接口文档开发_黑马程序员软件测试视频教程之接口测试全剖析
weixin_39597262的博客
12-03 287
什么是接口文档?“接口文档”又称为“API文档”，一般是由开发人员所编写的，用来描述系统所提供接口信息的文档。大家都根据这个接口文档进行开发，并需要一直维护和遵守。为什么要写接口文档?1)能够让前端开发与后台开发人员更好的配合，提高工作效率2)项目迭代或者项目人员更迭时，方便后期人员查看和维护3)方便测试人员进行接口测试接口测试的类型有哪些?我们在做接口测试的时候通常是对普通的http协议接口进行...
tlias智能学习辅助系统-员工管理
weixin_64485175的博客
01-09 1715
hello，好久不见，今天我们继续来学习tlias系统的员工管理实现，主要完成分页查询以及删除员工这两个功能的实现。
tlias智能学习辅助系统笔记
最新发布
04-03
### Tlias智能学习辅助系统笔记功能使用教程 Tlias智能学习辅助系统是一款基于Java Web技术开发的学习工具，其核心目标是帮助用户高效管理学习资源并提供智能化支持。以下是关于如何使用该系统的笔记功能的具体说明。 #### 1. 系统环境搭建 为了能够正常使用Tlias智能学习辅助系统的笔记功能，首先需要完成项目的初始化工作。这包括创建Spring Boot工程以及定义基础架构中的Mapper、Service（接口及其实现类）、Controller等模块[^1]。 通过这些组件的设计与实现，可以确保数据层、业务逻辑层和控制层之间的清晰分离，从而提升系统的可维护性和扩展性。 #### 2. 拦截器配置 在实际应用过程中，可能还需要对某些特定请求路径实施访问权限校验或其他预处理操作。此时可以通过`@WebFilter`注解来指定拦截规则[^2]。例如： - `/login`：仅允许未登录用户的认证页面加载； - `/emps/*`：针对员工相关API的安全防护； - `/*`：全局范围内的通用过滤机制。 ```java import javax.servlet.annotation.WebFilter; @WebFilter(filterName = "LoginInterceptor", urlPatterns = {"/login"}) public class LoginInterceptor { public void doFilter(...) { // 实现具体的拦截逻辑... } } ``` 上述代码片段展示了如何利用`@WebFilter`声明一个简单的Servlet Filter实例，并将其绑定到指定URL模式下生效。 #### 3. 笔记功能概述 根据已有资料介绍[Tlias智能学习辅助系统](https://ccnzas4uc87z.feishu.cn/wiki/BWxywO6atiZaVqkc4Okc6R8Vnzh)，其中提到该项目采用了Feishu作为外部协作平台用于存储内部文档信息[^3]。因此推测本系统的笔记部分很可能集成了第三方服务接口或者模仿类似的在线编辑体验设计思路。 假设我们希望模拟这样一个场景——即让用户能够在客户端界面上新增/修改个人知识点条目，则大致流程如下： ##### 数据交互模型 | 字段名 | 类型 | 描述 | |--------------|----------|-------------------------| | id | Integer | 唯一标识符 | | title | String | 主题名称 | | content | Text | 正文内容 | | createTime | DateTime | 创建时间戳 | | updateTime | DateTime | 更新时间戳 | ##### API端点示例 - **POST /api/note/create** 请求体参数应至少包含`title`, `content`两项基本信息。 - **PUT /api/note/update/{id}** 根据传入ID定位对应记录后执行覆盖保存动作。 - **DELETE /api/note/delete/{id}** 删除关联对象的同时也要注意清理冗余索引关系以防残留垃圾数据影响后续查询效率。 --- ### 注意事项 尽管当前公开的信息量有限，但从整体框架布局来看，开发者显然遵循了良好的软件工程实践原则。如果打算深入研究或二次开发此项目的话，建议先熟悉官方文档再逐步探索源码细节以免误触潜在风险区域。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值