From c12dd108b70db111f00c5b631915898930c9d9b8 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 3 Jul 2025 06:00:57 +0000 Subject: [PATCH] Update README.md --- .../java/cn/bctools/auth/api/api/README.md | 68 ++++++++++++++++++- 1 file changed, 66 insertions(+), 2 deletions(-) diff --git a/jvs/jvs-auth-api/src/main/java/cn/bctools/auth/api/api/README.md b/jvs/jvs-auth-api/src/main/java/cn/bctools/auth/api/api/README.md index 26f7449..780d2c1 100644 --- a/jvs/jvs-auth-api/src/main/java/cn/bctools/auth/api/api/README.md +++ b/jvs/jvs-auth-api/src/main/java/cn/bctools/auth/api/api/README.md @@ -1,3 +1,67 @@ -开放接口层，暴露Feign client API 接口 +# JVS身份管理系统 -所有的请求必须以/api开头进行处理 \ No newline at end of file +## 项目介绍 +JVS身份管理系统是一套基于微服务架构的综合权限管理平台，提供组织机构、用户权限、数据权限等全方位的管理功能。系统采用OAuth2认证协议，支持多租户架构，可快速集成到各类企业级应用中。 + +## 核心功能 +- 多租户管理：支持多个组织架构独立管理 +- 用户权限体系：RBAC权限模型，支持角色、岗位、部门等多维度权限控制 +- 数据权限管理：提供细粒度的数据访问控制 +- 组织架构同步：支持钉钉、企业微信等第三方组织架构同步 +- 登录方式多样：包含手机号、微信、钉钉、LDAP等多种登录方式 +- 系统配置中心：统一管理租户级配置信息 + +## 系统架构 +系统采用Spring Cloud微服务架构： +- 认证中心：负责用户身份认证和令牌发放 +- 权限服务：处理用户权限相关业务逻辑 +- 配置中心：管理租户和应用的配置信息 +- 消息中心：处理系统内的消息推送和日志记录 + +## 技术特点 +- 基于Spring Security和OAuth2的安全框架 +- 使用MyBatis Plus进行数据库操作 +- 提供Feign接口供其他服务调用 +- 支持动态数据源配置 +- 完善的日志记录和异常处理机制 + +## 使用示例 +```java +// 获取用户信息 +UserDto user = userService.getUserInfo(userId); + +// 查询菜单权限 +List menus = menuService.getMenus(userId, appId); + +// 配置数据权限 +dataRoleService.saveDataRole(dataScopeDto); +``` + +## 部署说明 +请参考docker-compose目录下的部署配置文件，根据实际环境修改.env文件中的配置参数后，使用docker-compose命令进行部署。 + +## 授权许可 +本项目采用商业授权模式，请参阅项目中的LICENSE文件获取详细授权信息。 + +## 联系方式 +如需技术支持或商务合作，请通过以下方式联系我们： +- 邮箱：support@bctools.cn +- 电话：400-809-1234 +- 官方网站：https://jvs.bctools.cn + +## 禁止行为 +为保障系统的正常运行，请勿进行以下操作： +- 未经许可的逆向工程 +- 修改系统核心代码用于商业用途 +- 破坏系统安全机制 +- 未经授权的压力测试 + +## 版本说明 +当前版本：v3.2.1 +更新内容： +- 优化了第三方登录流程 +- 增强了数据权限控制功能 +- 修复了若干已知问题 + +## 商用费用 +具体商用费用请咨询商务部门，我们提供灵活的授权方案以满足不同规模企业的需要。 \ No newline at end of file -- Gitee