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

简介: 本文介绍了入职后如何快速运行项目代码并完成Swagger接口文档集成的需求。涵盖代码克隆、环境配置、分支管理、提交规范及技术要点(git、maven、springboot、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

相关文章
|
负载均衡 Cloud Native Java
【云原生】Spring Cloud Alibaba 之 Gateway 服务网关实战开发
【云原生】Spring Cloud Alibaba 之 Gateway 服务网关实战开发
4025 0
|
5月前
|
Java Spring UED
Spring Cloud熔断降级
熔断降级是应对服务雪崩的核心手段。熔断通过断路器统计异常或慢请求比例,超阈值后拦截所有请求,防止系统崩溃;降级则在调用失败时返回默认数据或友好提示,提升用户体验。二者结合,在服务异常时快速熔断并触发降级逻辑。断路器有closed、open、half-open三种状态,实现自动恢复机制,保障系统稳定性。
Spring Cloud熔断降级
|
5月前
|
Java 数据库连接 调度
xxljob执行源码分析
本文深入解析XXL-JOB源码,涵盖架构设计、核心执行流程与关键线程机制。包括任务调度、快慢线程池分离、注册与心跳检测、失败重试告警、日志清理及时间轮原理,结合图文详解各组件实现逻辑,助你全面掌握分布式任务调度底层机制。
 xxljob执行源码分析
|
5月前
|
存储 关系型数据库 调度
|
5月前
|
存储 消息中间件 开发框架
应用架构图
技术架构是将业务需求转化为技术实现的关键过程,涵盖分层设计、技术选型与系统间关系梳理。本文详解单体与分布式架构,包括展现层、业务层、数据层及基础层的设计原则,并阐述应用内外调用关系与边界划分,助力构建清晰的技术体系。
 应用架构图
|
5月前
|
存储 算法 BI
xxljob本地运行
本文介绍XXL-JOB分布式任务调度框架的部署与使用,涵盖源码获取、服务端数据库初始化、配置启动、客户端注册及定时任务测试全过程,助您快速搭建并运行调度系统。
|
5月前
|
存储 Java 关系型数据库
微服务概述
本文对比单体与微服务架构,阐述微服务通过服务拆分、独立部署、技术自治等特性,提升系统可维护性和扩展性,同时分析其优缺点及实现方案,助力构建高效分布式系统。
|
5月前
|
存储 JSON NoSQL
MongoDB常用命令
本文介绍MongoDB数据库操作,包括数据库与集合的创建、删除,文档的增删改查及分页排序查询。以文章评论数据存储为例,详解CRUD操作及注意事项,如_id主键生成、数据类型处理、批量操作异常捕获等,适用于初学者快速掌握MongoDB基本用法。(238字)
MongoDB常用命令
|
5月前
|
缓存 Java Nacos
@RefreshScope热更新原理
本文深入解析Spring Cloud中@RefreshScope注解实现配置热更新的原理。通过分析其组合注解特性,重点探讨@Scope("refresh")如何借助缓存机制与动态代理,在配置变更时触发Bean重建,结合Nacos实现配置自动刷新。
@RefreshScope热更新原理
|
5月前
|
消息中间件 存储 Unix
Mac系统安装教程
RabbitMQ 是一个开源消息代理,实现AMQP协议,支持异步通信与解耦分布式系统。具备高可靠性、灵活路由、持久化及丰富插件,广泛用于微服务架构。

热门文章

最新文章