1.Knife4j @ApiModelProperty position不生效--避坑
2.Java21 + SpringBoot3整合springdoc-openapi，码解自动生成在线接口文档，码解支持SpringSecurity和JWT认证方式
3.神器 SpringDoc 横空出世！码解最适合 SpringBoot 的码解API文档工具来了
4.全面升级！一套基于Spring Boot 3+JDK17的码解实战项目！
5.springcloud服务启动后怎么知道接口调用路径？
6.一个注解干翻所有Controller

Knife4j @ApiModelProperty position不生效--避坑

       使用Knife4j结合swagger进行API文档生成时，码解网站源码程序常常能获得更美观的码解UI体验。然而，码解在处理DTO类注解@ApiModelProperty中的码解position属性时，你可能会遇到一些意想不到的码解麻烦。官方文档说明，码解position属性旨在允许开发者自定义字段在UI页面上的码解显示顺序，但在实际项目中，码解这个属性似乎并未如预期般生效。码解

       在深入探究问题原因时，码解发现项目中引用的swagger版本可能并未完全遵循官方文档指示，实际使用的可能是swagger2-3.0.0版本而非预期的2-2..5。这一细节的偏差可能导致了position属性无法正确应用。

       通常情况下，@ApiModelProperty注解的Model字段默认按字母顺序排列，这限制了用户自定义字段显示顺序的灵活性。若需改变字段显示顺序，position属性显得尤为重要。然而，实际测试中发现，position属性并未如预期般生效。

       在查阅官方GitHub的issue记录后发现，这一问题并非个例，菠菜站源码有用户反映在某些版本中，position属性的修复并未完全实现。一些解决建议包括重新实现ModelPropertyBuilderPlugin和OperationBuilderPlugin类，但这并未从根本上解决问题。

       深入源码分析后，最终定位问题在于Knife4j底层实现中的配置设置。在springfox.documentation.swagger2.mappers.CompatibilityModelMapper类中，useModelV3属性默认设置为true，导致分支在进行Model属性排序时，采用自然排序方式（按照字母顺序），而非期望的position优先排序方式。

       解决方案在于调整配置参数，将useModelV3属性改为false。通过这一调整，项目能够遵循ModelMapper的排序逻辑，即先考虑position属性，后按名称顺序排列，从而实现DTO字段的自定义显示顺序。

       总结上述内容，修改application.properties或application.yml配置文件，将useModelV3属性修改为false，是解决Knife4j中@ApiModelProperty position属性不生效问题的关键步骤。这一操作能够确保在API文档UI中，DTO字段按照开发者指定的顺序排列，提供更灵活、定制化的API文档体验。

Java + SpringBoot3整合springdoc-openapi，博客模板源码自动生成在线接口文档，支持SpringSecurity和JWT认证方式

       在Java 2.1与SpringBoot 3的项目开发中，我探索了一种方法，即通过整合springdoc-openapi来实现在线接口文档的自动生成，支持Spring Security和JWT认证。我的目标是打造一个适应多端且功能丰富的开发模板，方便开发者快速构建和扩展。

       本项目采用前后端分离模式，后端基于Java 2.1和SpringBoot 3，利用Spring Security、JWT、Spring Data JPA等技术进行开发，前端则提供了vue、angular、react、uniapp和微信小程序等多种技术栈。重点在于，如何利用OpenAPI规范来定义和展示API，这使得开发者无需深入了解源代码，就能理解API的功能和用法，极大地提高了开发效率。

       OpenAPI规范，即OAS，定义了RESTful API的通用标准，让开发者和工具能够理解和操作API。遵循OpenAPI，可以使用文档生成工具展示API，河狸家源码代码生成工具自动生成代码，甚至进行自动化测试。中国的OpenAPI规范中文版文档可参考这里。

       Swagger作为OpenAPI的实现工具，提供了组件如描述文件的维护，有助于更新文档和生成客户端和服务器端代码。Swagger的官方文档可在这里找到。

       Springfox是基于Swagger 2.x的API文档生成工具，它简化了Java开发者的工作，提供了注解支持和自动生成文档的功能。Springfox官方文档位于这里。

       然而，随着技术的发展，SpringDoc基于OpenAPI 3.0规范应运而生，成为了Spring Boot 2.4及以上版本的首选。相比Springfox，SpringDoc提供了更强大的扩展性和更好的社区支持。在SpringBoot 3中，推荐使用springdoc-openapi-ui进行集成。SpringDoc的官方文档可在这里查阅。

       在实践中，要实现这个功能，首先在pom.xml中引入springdoc-openapi-starter-webmvc-ui等相关依赖，然后配置application.yml，设定api-docs和swagger-ui的访问路径。如果项目有权限控制，需适当设置访问权限，挂靠网源码如允许匿名访问api-docs和swagger-ui。在Controller类和实体类中，使用@Operation注解配合之前定义的security配置来指定认证方式。

       通过上述步骤，你可以生成符合规范的接口文档，方便团队协作和API的使用。后续我会不断更新学习心得，期待与大家一起进步。

神器 SpringDoc 横空出世！最适合 SpringBoot 的API文档工具来了

       之前在SpringBoot项目中，我一直在使用SpringFox提供的Swagger库。然而，当我浏览其官网时，发现已经有将近两年没有出新版本了。最近，当我升级到SpringBoot 2.6.x版本时，发现这个库的兼容性也越来越差，有些常用注解属性甚至被废弃了，而库中并没有提供替代方案。偶然间，我发现了一款名为SpringDoc的Swagger库，试用后发现效果非常不错，因此推荐给大家。

       SpringDoc是一款基于OpenAPI 3的API文档生成工具，可以与SpringBoot结合使用。在Github上，它已经获得了超过1.7K个Star，更新发布也相当频繁，可以说是一款比Swagger库更好用的工具。值得一提的是，SpringDoc不仅支持Spring WebMvc项目，还可以支持Spring WebFlux项目，甚至Spring Rest和Spring Native项目，功能非常强大。下面是一张SpringDoc的架构图。

       接下来，我将介绍SpringDoc的使用方法。我将以之前集成SpringFox的mall-tiny-swagger项目为例，将其改造为使用SpringDoc。

       首先，我们需要集成SpringDoc。在pom.xml中添加它的依赖即可，开箱即用，无需任何配置。

       从SpringFox迁移结合SpringSecurity使用测试常用配置

       SpringDoc还有一些常用的配置可以了解，更多配置可以参考官方文档。

       总结

       在SpringFox的Swagger库好久不出新版的情况下，迁移到SpringDoc确实是一个更好的选择。今天我体验了一把SpringDoc，确实很好用，与之前熟悉的用法相似，学习成本极低。而且SpringDoc能支持WebFlux之类的项目，功能也更加强大，对于使用SpringFox觉得有些卡手的朋友来说，迁移到SpringDoc是一个不错的选择！

       参考资料项目源码地址：github.com/macrozheng/m...

       来源：mp.weixin.qq.com/s/scit...

全面升级！一套基于Spring Boot 3+JDK的实战项目！

       最近对mall项目进行了全面升级，支持了Spring Boot 3和JDK。以下是mall项目的升级内容，包括依赖升级、框架用法升级以及运行部署的改动。Spring Boot 3版本的代码位于mall项目的dev-v3分支。

       mall项目简介：mall项目是一个基于SpringBoot、Vue和uni-app实现的电商系统（Github标星K），采用Docker容器化部署。项目包括前台商城项目和后台管理系统，支持完整的订单流程，涵盖商品、订单、购物车、权限、优惠券、会员、支付等功能。

       项目演示：

       升级版本：项目中的依赖已经升级到最新主流版本，具体版本可参考下表。

       升级用法：在mall项目升级Spring Boot 3的过程中，部分框架的用法发生了变化。例如，生成API文档的库已从SpringFox迁移到SpringDoc，Spring Data Elasticsearch和Spring Security的用法也有所不同。以下将重点讲解这些升级的新用法。

       从SpringFox迁移到SpringDoc：由于之前使用的Swagger库为SpringFox，目前已不支持Spring Boot 3，因此已迁移到SpringDoc。

       Spring Data Elasticsearch新用法：Spring Data ES中基于ElasticsearchRepository的简单查询用法保持不变，但对于复杂查询，由于ElasticsearchRestTemplate类已被移除，需要使用ElasticsearchTemplate类来实现。

       Spring Security新用法：升级Spring Boot 3版本后，Spring Security的用法也有所变化。例如，某些实现动态权限的类已被弃用，Security配置改用函数式编程的方式。

       其他运行部署：由于Spring Boot 3最低要求是JDK，在Windows下运行项目时需要配置好项目的JDK版本，其他操作与之前版本相同。

       Linux：在打包应用的Docker镜像时，需要配置项目使用openjdk:。这可以在项目根目录下的pom.xml中修改docker-maven-plugin插件配置完成。

       由于镜像使用了openjdk:，在打包镜像之前需要提前下载好openjdk的镜像。可以使用以下命令下载，其他操作与之前版本部署相同。

       总结：今天主要讲解了mall项目升级Spring Boot 3版本的一些注意点。项目源码地址：github.com/macrozheng/m...

springcloud服务启动后怎么知道接口调用路径？

       在Spring Cloud服务启动后，可以使用Swagger UI工具查看服务的接口调用路径。Swagger是一种开放源代码软件框架，可以生成、描述、调用和可视化RESTful Web服务。

       要使用Swagger UI工具，需要在Spring Cloud项目中引入相应的依赖，然后配置相应的Swagger配置类，如下所示：

       引入Swagger2和Swagger UI的依赖：

       <dependency>

       <groupId>io.springfox</groupId>

       <artifactId>springfox-swagger2</artifactId>

       <version>2.9.2</version>

       </dependency>

       <dependency>

       <groupId>io.springfox</groupId>

       <artifactId>springfox-swagger-ui</artifactId>

       <version>2.9.2</version>

       </dependency>

       编写Swagger配置类，用于配置Swagger相关信息：

       @Configuration

       @EnableSwagger2

       public class SwaggerConfig {

       @Bean

       public Docket api() {

       return new Docket(DocumentationType.SWAGGER_2)

       .select()

       .apis(RequestHandlerSelectors.any())

       .paths(PathSelectors.any())

       .build();

       }

       }

       启动Spring Cloud服务，然后在浏览器中访问Swagger UI，可以查看API文档。

       默认情况下，Swagger UI的访问路径为 mand-dispatcher-controller和query-dispatcher-controller。command-dispatcher-controller主要负责CommanderService的Web暴露，支持业务操作如创建、更新等，query-dispatcher-controller则负责QueryService的Web暴露，用于执行业务查询操作，并支持RequestBody和RequestParam两种接入方式。

       在深入使用过程中，会遇到一些疑惑：serviceName和method参数从何获取？nativeRequest和nativeResponse又是何物？这两个接口如何使用？这些问题的解答并不直观，因为用户通常不会直接使用这两个处理器。

       对于Command控制器的使用，只需在OrderCommandService接口上添加@AutoRegisterWebController注解，即可将其对外暴露为Web端口。通过访问指定地址，可以看到OrderCommandService服务中的所有方法都在Controller中得到了体现。以create方法为例，可以发现与手写Controller的结构和功能基本一致。

       同样的，对于Query控制器，同样通过在OrderQueryService接口上添加@AutoRegisterWebController注解实现暴露。在访问指定地址并展开QueryByBody和QueryByParam方法后，可以清晰地看到与手写Controller相似的结构和功能。

       设计与扩展部分，整个设计可以分为两部分：统一Controller与Swagger集成。统一Controller部分提供QueryDispatcherController作为所有查询请求的入口，其核心架构涉及初始化和执行流程。与Swagger的集成则通过QueryServiceProvider实现，此组件依赖于QueryMethodRegistry中的QueryMethod信息，确保提供了完整的API文档。设计流程同样围绕QueryDispatcherController展开，确保与QueryServiceProvider的一致性。

       在项目信息部分，此解决方案来源于geekhalo，提供了一套高效、简洁的Controller替代方案，旨在简化开发流程，提升开发效率和代码质量。