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

简介: 本文介绍如何从Gitee克隆项目并运行代码,涵盖JDK、Maven等环境配置问题的应对策略,强调新人应主动请教同事。要求使用Swagger优化接口文档,实现参数校验与功能描述,并遵循Git分支命名及提交规范,提升开发效率。

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


相关文章
|
2月前
|
敏捷开发 Java 测试技术
为什么要单元测试
本文探讨单元测试如何提升软件研发效率,打破“写单测拖慢进度”的误区。通过解析测试金字塔,阐明单元测试在保障代码质量、提升可维护性与团队协作中的核心作用,并揭示常见反模式与认知误区,倡导开发者重视单测,实现从“爬行”到“奔跑”的工程进化。
为什么要单元测试
|
2月前
|
消息中间件 监控 Java
RocketMQ:底层Netty频繁OS OOM
本文记录了一例Java应用因Netty多ClassLoader加载多个PooledByteBufAllocator实例,导致堆外内存超限引发OS OOM的排查过程。通过NMT、Arthas等工具分析,发现多个中间件独立加载Netty,各自绕过JVM直接内存限制分配堆外内存,总量远超MaxDirectMemorySize。最终定位RocketMQ客户端为主要内存占用者,建议短期调小Java堆让出内存,长期优化中间件内存使用。
 RocketMQ:底层Netty频繁OS OOM
|
2月前
|
存储 缓存 监控
EFC&CTO:缓存引发数据不一致问题排查与深度解析
EFC客户端在适配CTO测试时发现数据不一致问题,经排查为分布式缓存版本号回退导致读取旧数据,进而污染pagecache并写坏文件系统。通过维护递增版本号修复,最终解决问题并优化对POSIX语义的理解。
|
2月前
|
负载均衡 算法 Java
5-微服务篇
本文详解SpringBoot自动装配原理、启动流程、核心注解@SpringBootApplication组成,以及SpringCloud微服务中注册发现、负载均衡、限流熔断等机制,涵盖常用组件如Nacos、Ribbon、Feign、Sentinel及Gateway的使用与配置,适用于面试与实战。
|
2月前
|
存储 关系型数据库 MySQL
7-事务控制篇
本文简要介绍了关系型与非关系型数据库的区别、索引的作用及类型、B+树与B树的差异、事务ACID特性、隔离级别、锁机制、数据库优化策略等内容,涵盖MySQL存储引擎、聚簇索引、覆盖索引、分库分表等核心知识点,系统梳理了数据库原理与性能调优关键点。
|
2月前
|
存储 缓存 安全
1-Java基础篇
本文系统讲解Java核心知识,涵盖final关键字、重载与重写、==与equals区别、反射机制、String类对比、集合框架、线程安全类、HashMap原理、ConcurrentHashMap实现、线程池使用与参数配置、JVM组成及运行时数据区、类加载器与双亲委派模型等,结合项目实践解析技术应用。
|
2月前
|
存储 SQL 关系型数据库
3-MySQL篇
本文系统梳理MySQL核心知识点,涵盖查询语句的书写与执行顺序、多表连接方式、索引类型及底层结构(B+树)、聚簇与非聚簇索引区别、回表查询与覆盖索引优化、最左前缀原则、索引失效场景、SQL性能分析(EXPLAIN)及慢查询定位等,助力高效数据库开发与调优。
|
2月前
|
消息中间件 存储 缓存
6-MQ篇
项目中广泛使用RabbitMQ、Kafka和EMQ实现异步通信。RabbitMQ用于内容审核、数据采集等场景,支持多种消息模式与高可用集群;Kafka处理高吞吐用户行为数据,保障实时推荐与数据同步;EMQ则应用于物联网设备通信,支持QoS等级保证消息可靠传输。三者均通过确认机制、持久化、重试等策略保障消息不丢失与系统稳定性。
|
2月前
|
自然语言处理 fastjson Java
FastJson:大面积故障规避案例
本文记录了一次由Kotlin与Java混编工程中误用`{}`赋值引发的FastJson反序列化崩溃问题。因将空对象误写为lambda表达式,导致FastJson内部静态标记位`kotlin_error`被置为true且无法恢复,进而使整个应用反序列化链路瘫痪。问题隐蔽性强,排查耗时两天,最终通过源码分析定位。文章反思了多语言混编下的语法混淆风险、框架信任边界及灰度发布的重要性,强调Bug是成长的阶梯。
 FastJson:大面积故障规避案例
|
2月前
|
SQL 分布式计算 运维
XXLJOB:超长定时任务慢节点优化实践
本文针对ODPS大宽表任务运行缓慢问题,通过定位耗时卡点、解决数据倾斜与计算堆积,提出视图落表、节点拆分、前置裁剪、中表关联等优化方案,显著提升任务效率,产出时间提前4小时以上,并降低回刷成本与资源消耗。