[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

相关文章
|
JSON Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的使用
本文详细介绍了Swagger2的使用方法,包括在Spring Boot项目中的配置与应用。重点讲解了Swagger2中常用的注解,如实体类上的`@ApiModel`和`@ApiModelProperty`,Controller类上的`@Api`、`@ApiOperation`以及参数上的`@ApiParam`等。通过示例代码展示了如何为实体类和接口添加注解,并在页面上生成在线接口文档,实现接口测试。最后总结了Swagger的优势及其在项目开发中的重要性,提供了课程源代码下载链接供学习参考。
1084 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的使用
|
负载均衡 Cloud Native Java
【云原生】Spring Cloud Alibaba 之 Gateway 服务网关实战开发
【云原生】Spring Cloud Alibaba 之 Gateway 服务网关实战开发
4350 0
|
9月前
|
Java Spring UED
Spring Cloud熔断降级
熔断降级是应对服务雪崩的核心手段。熔断通过断路器统计异常或慢请求比例,超阈值后拦截所有请求,防止系统崩溃;降级则在调用失败时返回默认数据或友好提示,提升用户体验。二者结合,在服务异常时快速熔断并触发降级逻辑。断路器有closed、open、half-open三种状态,实现自动恢复机制,保障系统稳定性。
Spring Cloud熔断降级
|
9月前
|
负载均衡 Java 应用服务中间件
微服务网关与配置中心
本文介绍了微服务架构下的网关路由与鉴权机制,重点讲解使用Spring Cloud Gateway实现请求路由、负载均衡及JWT身份校验。通过Nacos实现服务发现,网关统一处理前端请求,解决多入口问题,并在全局过滤器中实现用户鉴权,保障系统安全。
|
9月前
|
负载均衡 Java Nacos
微服务网关与配置中心
本文介绍了基于Spring Cloud Gateway实现微服务网关的完整流程,涵盖路由转发、负载均衡、全局过滤器与身份校验、用户信息传递及配置中心Nacos的集成。通过自定义GlobalFilter实现JWT鉴权,并利用ThreadLocal在微服务间透传用户信息;针对Feign调用场景,设计无状态内部接口以提升通用性;最后通过Nacos统一管理各服务配置文件,支持热更新,实现配置集中化与动态化管理。
 微服务网关与配置中心
|
9月前
|
存储 消息中间件 开发框架
应用架构图
技术架构是将业务需求转化为技术实现的关键过程,涵盖分层设计、技术选型与系统间关系梳理。本文详解单体与分布式架构,包括展现层、业务层、数据层及基础层的设计原则,并阐述应用内外调用关系与边界划分,助力构建清晰的技术体系。
 应用架构图
|
9月前
|
存储 算法 BI
xxljob本地运行
本文介绍XXL-JOB分布式任务调度框架的部署与使用,涵盖源码获取、服务端数据库初始化、配置启动、客户端注册及定时任务测试全过程,助您快速搭建并运行调度系统。
|
9月前
|
存储 关系型数据库 调度
|
9月前
|
Java 数据库连接 调度
xxljob执行源码分析
本文深入解析XXL-JOB源码,涵盖架构设计、核心执行流程与关键线程机制。包括任务调度、快慢线程池分离、注册与心跳检测、失败重试告警、日志清理及时间轮原理,结合图文详解各组件实现逻辑,助你全面掌握分布式任务调度底层机制。
 xxljob执行源码分析
|
9月前
|
缓存 NoSQL 关系型数据库
微服务原理篇(Canal-Redis)
该文章内容详细且实用
 微服务原理篇(Canal-Redis)