|
1 week ago | |
---|---|---|
k8s | 1 week ago | |
plugins | 1 week ago | |
sql | 1 week ago | |
src | 1 week ago | |
themes | 1 week ago | |
.gitignore | 1 week ago | |
CHANGELOG.md | 1 week ago | |
Dockerfile | 1 week ago | |
LICENSE | 1 week ago | |
README.md | 1 week ago | |
pom.xml | 1 week ago | |
start.sh | 1 week ago |
需要java17、Maven 3.6.3+
项目基于 SpringBoot3、SpringSecurity6 、 JWT 、 Redis 、 Mybatis-Plus 、 Knife4j 等技术栈搭建的前后端分离开源权限管理系统。
knife4j
接口文档:http://localhost:8989/doc.html
swagger
接口文档:http://localhost:8989/swagger-ui/index.html
执行 youlai_boot.sql 脚本完成数据库创建、表结构和基础数据的初始化。
application-dev.yml 修改MySQL、Redis连接配置;
执行 SystemApplication.java 的 main 方法完成后端项目启动;
访问接口文档地址 http://localhost:8989/doc.html 验证项目启动。
文档:README.md
以下命名涵盖了Controller、Service和Mapper层
作用 | 示例 |
---|---|
分页查询 | getUserPage |
列表查询 | listUsers |
单个查询 | getUser/getUserDetail/getUserInfo ... |
新增 | saveUser |
修改 | updateUser |
删除 | deleteUser/removeUser |
名称 | 定义 | 示例 |
---|---|---|
entity | 映射数据库实体,字段属性完全对应 | SysUser |
bo | 多表关联查询的业务实体 | UserBO |
query | 查询传参,建议参数≥3使用 | UserQuery |
form | 表单对象 | UserForm |
dto | RPC调用,可替代VO | UserDTO |
vo | 视图层对象 | UserVO |
在RESTFul架构中,每个URL代表一种资源,所以不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合",所以API中的名词也应该使用复数。
请求示例:
请求描述 | 请求方法 | 请求路径 |
---|---|---|
获取所有用户信息 | GET | /api/v1/users |
获取标识为1用户信息 | GET | /api/v1/users/1 |
删除标识为1用户信息 | DELETE | /api/v1/users/1 |
新增用户 | POST | /api/v1/users |
修改标识为1用户信息 | PUT | /api/v1/users/1 |
修改标识为1用户状态 | PATCH | /api/v1/users/1/status |
获取当前登录用户信息 | GET | /api/v1/users/{me,current} |
参考 阿里Java开发手册
参考 (Angular) 社区规范,建议 IDEA 安装 Git Commit Template 插件
feat
增加新功能fix
修复问题/BUGstyle
代码风格相关无影响运行结果的perf
优化/性能提升refactor
重构revert
撤销修改test
测试相关docs
文档/注释chore
依赖更新/脚手架配置修改等workflow
工作流改进ci
持续集成