[ERP]SpringBoot集成Swagger技术(☆)

简介: 本文介绍如何从Gitee克隆项目并运行代码,涵盖环境配置、代码分支管理及提交规范。要求使用Swagger对接口进行文档化,实现参数校验与功能描述,并强调在真实开发中如何高效沟通、快速上手项目需求。

1.代码运行

git仓库地址:https://gitee.com/Herbbbb/erphome-work

请你完成以下步骤

方案一:

  • 克隆代码到Idea,如果你时间允许不妨试试SSH拉取方式

方案二

  • 下载Zip包,不建议,但如果上班后短时间拉不下来优先这种方式让代码跑起来

入职后,对于JDK、Maven、Git、Idea....软件安装类你应该请教谁?

  • 以上问题,是大家面临的第一道坎,15K大佬一样一天配置不好maven仓库,请认真思考该请教谁?

当你意识到,公司的环境配置类问题都可以问同事、组长的时候你应该怎么问?

  • 不知道该不该问?不敢问?这是多数新人最纠结的一个点,请认真思考你会怎么问

当你把项目运行起来之后,此时一个全新的工程在你面试,组长立马就给你如下的需求,你会怎么处理?

  • 现在的公司愈发需要即战力,一个陌生的环境、工程、团队,紧急的任务,请认真思考你将怎么着手?

2.需求描述

现有的三层架构代码,前端反馈看不懂,需要通过swagger包装一下,请你完成

  • 所有接口的入参、出参都能够看懂
  • 所有接口都有功能描述
  • 所有请求入参,做好非空校验
  • 注意,不是自己手动if-else,而是借助于@NotNull或者@NotEmpty注解

以上这句话你可能不理解,上班也存在大量这样一句话需求,怎么保证自己能知道做什么是很重要的。

最终参考实现效果:

2.1 多说一句(做完再看)

  • 你是否考虑过此次修改需要创建新的分支
  • 你是否知道创建分支、代码提交的规范
  • 分支创建默认:
  • feature-姓名缩写-需求描述
  • 如:feature-hb-addSwaggerDoc
  • 代码提交规范
  • 新增功能提交注释:feat:需求描述
  • 如:feat:新增swagger
  • 修改功能提交注释:fix:需求描述【最常用】
  • 如:fix:修改原订单逻辑,增加Redis缓存
  • 重构功能提交注释:refactor:需求描述
  • 如:refactor:重构商品模块

3.涉及技术点

阶段二核心:git、maven、springboot、swagger

相关文章
|
1天前
|
Java 数据库连接 mybatis
Mybatis及MybatisPlus
本文系统介绍MyBatis核心架构与常用功能,涵盖配置流程、结果集映射、参数传递、XML配置项、缓存机制及分页插件应用,并简要介绍MyBatis Plus的常用API,助力高效开发。
Mybatis及MybatisPlus
|
1天前
|
开发工具 git 运维
生产环境缺陷管理
git-poison基于go-git实现,通过“投毒-解毒”机制自动化追踪和管理多分支环境下的bug修复,避免人为疏漏导致的生产事故,降低协同成本,提升发布安全与效率。
生产环境缺陷管理
|
1天前
|
Kubernetes 容器 运维
物理部署图
物理部署图描述系统运行时的硬件配置与软件部署结构,展现节点、构件、物件及连接关系,帮助理解分布式系统的网络架构与运维逻辑,是实现应用与硬件协同运行的重要设计工具。
 物理部署图
|
1天前
|
Java 数据安全/隐私保护 安全
2.通用权限管理模型
本文介绍了ACL和RBAC两种常见的权限模型。ACL通过直接为用户或角色授权实现访问控制,简单直观;RBAC则基于角色进行权限管理,支持角色继承与职责分离,结构更清晰、易于维护,是现代系统主流的权限设计方式。
2.通用权限管理模型
|
1天前
|
Java 调度 容器
线程池
本文深入剖析了Java线程池的核心原理,涵盖ThreadPoolExecutor与ScheduledThreadPoolExecutor的实现机制,重点解析了任务调度、线程复用、阻塞队列及周期性执行等关键技术,并结合源码阐述了Executors工具类和ThreadLocal的应用。
 线程池
|
1天前
|
Java 数据安全/隐私保护 Spring
3.实现权限管理的技术
本文介绍了权限管理的常见技术选型,对比了Apache Shiro、Spring Security及自定义ACL的优缺点,帮助开发者根据项目需求选择合适方案。
 3.实现权限管理的技术
|
1天前
|
uml C语言
系统时序图
时序图(Sequence Diagram)是UML中描述对象间消息传递时间顺序的交互图。横轴为对象,纵轴为时间,通过生命线、控制焦点和消息等元素,展现系统动态协作过程,强调交互的时间顺序与并发行为,常用于分析和设计系统逻辑。
 系统时序图
|
1天前
|
领域建模 数据采集 数据库
领域模型图(数据架构/ER图)
本文介绍如何通过四色原型法进行领域建模,构建数据架构中的ER图。基于业务流程提取时标性原型(MI)、参与方-地点-物品原型(PPT)、角色原型(Role)和描述原型(DESC),逐步建立风控系统的领域模型,并最终转化为实体关系图(ER图),实现从业务到数据模型的精准映射。(238字)
 领域模型图(数据架构/ER图)
|
1天前
|
Java Kubernetes 容器
物理部署图
物理部署图描述系统运行时的硬件配置与软件部署结构,展现节点、构件、物件及连接关系,帮助开发与运维人员理解分布式系统的部署架构,实现软硬件协同。
物理部署图
|
1天前
|
Java 大数据
ArrayList扩容机制
本文深入分析了Java中ArrayList的add及扩容机制。首次添加元素时,默认容量由0扩容至10;每次扩容为原容量的1.5倍(通过位运算提升效率),并通过ensureCapacityInternal、grow等方法实现动态扩容,同时介绍了length、length()、size()的区别与应用场景。