AI时代代码开发(接口设计)

简介: 本章节基于页面原型与接口模板,采用Restful风格设计部门与员工管理模块的API接口,涵盖查询、新增、修改、删除等功能,严格遵循JSON格式与字段规范,确保前后端高效对接。

我们新的AI设计方式,将基于下述核心流程
问小白不能同时支持:图片、附件的形式,所以本章节我们的分析将回到:https://chat.deepseek.com/
1.部门管理接口设计
上传资料中的两个关键信息:
资料\01. 页面原型\截图\部门管理.png
资料\04. 接口文档\接口文档模板.pdf
加上关键性的提示语
请严格根据提供的部门管理的页面原型和需求说明,以及提供的接口文档的模板,参照提供的部门表dept的表结构,基于Restful风格,帮我设计部门管理模块涉及到的接口文档。dept部门表的表结构如下:
CREATE TABLE dept(
id INT AUTO INCREMENT PRIMARY KEY COMMENT'部门ID(唯一标识,自增主键)'name VARCHAR(10) NOT NULL UNIQUE COMMENT'部门名称”create time DATETIME NOT NULL DEFAULT CURRENT TIMESTAMP COMMENT '创建时间'update time DATETIME NOT NULL DEFAULT CURRENT TIMESTAMP ON UPDATECURRENT TIMESTAMP COMMENT'最后操作时间')ENGINE=InnODB DEFAULT CHARSET=utf8mb4 COMMENT='部门信息表”;
耐心等待之后,可以发现跟我们需要的模板是一致的【可以自行详细分析】
1.1 部门列表查询
1.2 删除部门
基本信息
请求路径:/depts/{id}
请求方式:DELETE
接口描述:该接口用于根据ID删除部门数据
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
部门ID
请求参数样例:
/depts/1
/depts/2
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
1.3 添加部门
基本信息
请求路径:/depts
请求方式:POST
接口描述:该接口用于添加部门数据
请求参数
格式:application/json
参数说明:
参数名
类型
是否必须
备注
name
string
必须
部门名称
请求参数样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
1.4 根据ID查询
基本信息
请求路径:/depts/{id}
请求方式:GET
接口描述:该接口用于根据ID查询部门数据
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
部门ID
请求参数样例:
/depts/1
/depts/3
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
|- id
number
非必须
id
|- name
string
非必须
部门名称
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
修改时间
响应数据样例:
1.5 修改部门
基本信息
请求路径:/depts
请求方式:PUT
接口描述:该接口用于修改部门数据
请求参数
格式:application/json
参数说明:
参数名
类型
是否必须
备注
id
number
必须
部门ID
name
string
必须
部门名称
请求参数样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
2.员工管理
2.1 员工列表查询
基本信息
请求路径:/emps
请求方式:GET
接口描述:该接口用于员工列表数据的条件分页查询
请求参数
参数格式:queryString
参数说明:
参数名称
是否必须
示例
备注
name


姓名
gender

1
性别 , 1 男 , 2 女
begin

2010-01-01
范围匹配的开始时间(入职日期)
end

2020-01-01
范围匹配的结束时间(入职日期)
page

1
分页查询的页码,如果未指定,默认为1
pageSize

10
分页查询的每页记录数,如果未指定,默认为10
请求数据样例:
/emps?page=1&pageSize=10
/emps?name=张&page=1&pageSize=10
/emps?gender=1&page=1&pageSize=10
/emps?name=张&gender=1&page=1&pageSize=10
/emps?name=张&gender=1&begin=2007-09-01&end=2022-09-01&page=1&pageSize=10
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- total
number
必须
总记录数
|- rows
object []
必须
数据列表
|- id
number
非必须
id
|- username
string
非必须
用户名
|- name
string
非必须
姓名
|- gender
number
非必须
性别 , 1 男 ; 2 女
|- image
string
非必须
图像
|- position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
|- salary
number
非必须
薪资
|- hireDate
string
非必须
入职日期
|- deptId
number
非必须
部门id
|- deptName
string
非必须
部门名称
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
响应数据样例:
2.2 删除员工
基本信息
请求路径:/emps
请求方式:DELETE
接口描述:该接口用于批量删除员工的数据信息
请求参数
参数格式:查询参数
参数说明:
参数名
类型
示例
是否必须
备注
ids
数组 array
1,2,3
必须
员工的id数组
请求参数样例:/emps?ids=1,2,3
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
2.3 添加员工
基本信息
请求路径:/emps
请求方式:POST
接口描述:该接口用于添加员工的信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
username
string
必须
用户名
name
string
必须
姓名
gender
number
必须
性别, 说明: 1 男, 2 女
image
string
非必须
图像
deptId
number
非必须
部门id
hireDate
string
非必须
入职日期
position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
salary
number
非必须
薪资
exprList
object[]
非必须
工作经历列表
|- company
string
非必须
所在公司
|- position
string
非必须
职位
|- startDate
string
非必须
开始时间
|- endDate
string
非必须
结束时间
请求数据样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
2.4 根据ID查询
基本信息
请求路径:/emps/{id}
请求方式:GET
接口描述:该接口用于根据主键ID查询员工的信息
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
员工ID
请求参数样例:/emps/1
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- id
number
非必须
id
|- username
string
非必须
用户名
|- name
string
非必须
姓名
|- password
string
非必须
密码
|- hireDate
string
非必须
入职日期
|- gender
number
非必须
性别 , 1 男 ; 2 女
|- image
string
非必须
图像
|- position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
|- salary
number
非必须
薪资
|- deptId
number
非必须
部门id
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
|- exprList
object[]
非必须
工作经历列表
|- id
number
非必须
ID
|- company
string
非必须
所在公司
|- position
string
非必须
职位
|- startDate
string
非必须
开始时间
|- endDate
string
非必须
结束时间
|- empId
number
非必须
员工ID
响应数据样例:
2.5 修改员工
基本信息
请求路径:/emps
请求方式:PUT
接口描述:该接口用于修改员工的数据信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
id
number
必须
id
username
string
必须
用户名
name
string
必须
姓名
gender
number
必须
性别, 说明: 1 男, 2 女
image
string
非必须
图像
deptId
number
非必须
部门id
hireDate
string
非必须
入职日期
position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
salary
number
非必须
薪资
exprList
object[]
非必须
工作经历列表
|- id
number
非必须
ID
|- company
string
非必须
所在公司
|- position
string
非必须
职位
|- startDate
string
非必须
开始时间
|- endDate
string
非必须
结束时间
|- empId
number
非必须
员工ID
请求数据样例:
JSON

{
"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",
"position": 2,
"salary": 8000,
"hireDate": "2015-01-01",
"deptId": 2,
"createTime": "2022-09-01T23:06:30",
"updateTime": "2022-09-02T00:29:04",
"exprList": [
{
"id": 1,
"startDate": "2012-07-01",
"endDate": "2015-06-20",
"company": "中软国际股份有限公司",
"position": "java开发",
"empId": 2
},
{
"id": 2,
"startDate": "2015-07-01",
"endDate": "2019-03-03",
"company": "百度科技股份有限公司",
"position": "java开发",
"empId": 2
},
{
"id": 3,
"startDate": "2019-3-15",
"endDate": "2023-03-01",
"company": "阿里巴巴科技股份有限公司",
"position": "架构师",
"empId": 2
}
]
}
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
JSON

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

相关文章
|
6月前
|
存储 缓存 监控
深度剖析阿里巴巴平台商品详情接口:技术、应用与代码实战
阿里巴巴商品详情接口基于RESTful架构,使用HTTP协议通信,支持GET和POST请求方式。开发者需通过App Key和App Secret进行签名认证,确保接口安全调用。核心端点如`https://api.1688.com/router/rest?method=alibaba.item.get`可用于获取商品基本信息,常见参数包括`fields`(指定返回字段)和`num_iid`(商品ID)。接口响应为JSON格式,包含商品标题、价格、库存、描述、图片链接、供应商信息等。开发者可结合实际需求进行数据提取与处理。
|
8天前
|
XML 自然语言处理 机器人
SpringAI
SpringAI整合全球主流大模型,支持多种技术架构,提供统一开发接口。本文以OpenAI和Ollama为例,详解如何通过SpringAI快速构建对话机器人,涵盖项目搭建、依赖引入与配置,助力开发者高效上手大模型应用开发。
|
8天前
|
前端开发
前端(Cursor)-员工管理
根据页面原型与接口文档,完成员工管理功能开发,实现增删改查及分页查询。按要求调整新增员工表单布局为六行结构,宽度800px,包含用户名、姓名、性别、手机号、职位、薪资、部门、入职日期、头像上传及可动态增删的工作经历项,确保界面与交互符合设计。
|
8天前
|
JavaScript 前端开发 算法
React框架
React是一个用于构建用户界面的JavaScript库,专注于视图层,采用虚拟DOM和Diff算法实现高效渲染。支持组件化开发、服务端渲染、状态管理,易于测试与集成,通过生命周期、setState机制及高阶组件等特性提升开发效率与性能。
|
8天前
|
存储 安全 开发工具
Git 的基础知识
在软件开发中,版本控制如Git至关重要,它支持代码历史追踪、团队协作、分支实验、错误回滚与代码审查。通过提供变更审计轨迹、备份恢复及功能隔离,提升开发效率与代码质量,助力团队高效协同,保障项目稳定演进。
|
8天前
|
存储 JSON NoSQL
MongoDB常用命令
本文介绍MongoDB数据库操作,以文章评论系统为例,涵盖数据库与集合的创建、删除,文档的增删改查、批量操作、投影查询、分页排序及统计功能,详细说明数据插入、更新条件控制、分页查询等常用操作方法。
|
8天前
|
缓存 Java 数据库连接
mybatis常见配置
本文介绍MyBatis核心配置机制,涵盖属性加载优先级(方法参数 > resource/url > properties内嵌)、常用配置项如缓存、延迟加载、执行器类型等,并详解多环境配置方式及事务管理(JDBC与MANAGED)。适用于需灵活管理数据源与事务的开发者。
|
8天前
|
XML Java 数据格式
springboot@Configuration
`@Configuration` 注解用于标记配置类,相当于 XML 配置文件,配合 `@Bean` 注解注册 Bean 到 Spring 容器。通过 `AnnotationConfigApplicationContext` 可加载配置类并启动 IOC 容器,实现组件的自动管理与注入。
|
8天前
|
人工智能 自然语言处理 Cloud Native
AI时代代码开发(DeepSeek+Cursor+Devbox)
AI时代重塑软件开发,本课程聚焦DeepSeek+Cursor+Devbox+Sealos工具链,实现自然语言到代码的零基础全栈开发。覆盖需求分析、数据库设计、编码测试至云部署全流程,助力开发者高效构建并上线项目,抢占智能开发先机。(238字)
|
8天前
|
存储 SQL 人工智能
AI时代代码开发(数据库设计)
本文介绍基于三范式与DDD的数据库设计流程,结合AI工具辅助分析页面原型,通过部门、员工及工作经历模块,演示表结构设计与优化过程,强调人工校验与调整的重要性,最终完成符合业务需求的数据库建模与测试数据构建。

热门文章

最新文章