首页
/ RuoYi-Vue-Pro项目新建模块时Controller包路径的注意事项

RuoYi-Vue-Pro项目新建模块时Controller包路径的注意事项

2025-05-05 07:52:25作者:宗隆裙

在基于RuoYi-Vue-Pro框架进行二次开发时,新建模块是一个常见的操作。本文主要讲解在新建模块过程中关于Controller包路径配置的关键注意事项,帮助开发者避免常见的404错误问题。

包路径与API访问路径的映射关系

RuoYi-Vue-Pro框架采用了清晰的包结构设计,其中Controller的包名直接决定了API的访问路径前缀:

  • controller.admin包中的Controller:对应/admin-api/前缀
  • controller.app包中的Controller:对应/app-api/前缀
  • controller.user包中的Controller:对应/user-api/前缀

这种设计使得API路由更加规范,便于管理和维护。

常见错误场景分析

许多开发者在新建模块时,容易犯以下错误:

  1. 将本应放在controller.app包中的Controller类错误地放置在controller.user包中
  2. 没有注意到框架的包路径与API前缀的映射关系
  3. 在测试时使用了错误的API前缀访问接口

例如,当开发者将AppDemoTestController放在controller.user包中,却尝试通过/app-api/demo/test/get路径访问时,就会遇到404 Not Found错误。

正确的配置方法

  1. 确定API类型:首先明确你要开发的API类型是管理后台(admin)、用户端(user)还是应用端(app)

  2. 创建对应包结构

    • 管理后台API:controller.admin
    • 用户端API:controller.user
    • 应用端API:controller.app
  3. 编写Controller:在正确的包路径下创建Controller类

  4. 测试验证:使用正确的API前缀进行测试

其他相关注意事项

  1. Swagger文档显示:确保在yudao-server模块的pom.xml中添加了对新建模块的依赖,否则Swagger文档中不会显示新增的API接口

  2. API文档查找:Swagger文档中的测试项默认没有按字母排序,查找时需要仔细

  3. 模块依赖管理:新建模块后,需要在主项目的依赖管理部分添加对新模块的引用

通过遵循上述规范和注意事项,开发者可以避免在RuoYi-Vue-Pro项目中新建模块时遇到的各种路由和访问问题,提高开发效率和代码质量。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8