首页 > 其他分享 >Spring Boot —— 集成文档工具

Spring Boot —— 集成文档工具

时间:2024-05-20 22:29:49浏览次数:29  
标签:集成 Spring Boot ui springdoc 文档 Swagger

Swagger -> SpringDoc

官网地址:https://springdoc.org/
是基于OpenAPI 3.0 规范构建的集成 Swagger UI 和 ReDoc 文档生成工具,可自动注入OpenAPI规范的JSON描述文件,支持OAUTH2、JWT等认证机制。推荐 Spring Boot 2.4 及以上版本使用springdoc-openapi-ui集成Swagger 3.x,Spring Boot 2.3及以下版本使用springfox-boot-starter集成Swagger 2.x,Spring Boot 3使用springdoc-openapi-starter-webmvc-ui引入。

pom

<!--spring boot >=2.4 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.7.0</version>
</dependency>

访问

启动项目浏览/swagger-ui.html即可看到效果,默认会列出所有Controller及方法。

配置

springdoc:
  api-docs:
    enabled: true
	path: '/docs'
  swagger-ui:
  	path: ''

参考资料

Spring Boot 2.x集成Spring Doc(Swagger 3.0)

标签:集成,Spring,Boot,ui,springdoc,文档,Swagger
From: https://www.cnblogs.com/cinlap/p/18202950

相关文章

  • 13年过去了,Spring官方竟然真的支持Bean的异步初始化了!
    你好呀,我是歪歪。两年前我曾经发布过这样的一篇文章《我是真没想到,这个面试题居然从11年前就开始讨论了,而官方今年才表态。》文章主要就是由这个面试题引起:Spring在启动期间会做类扫描,以单例模式放入ioc。但是spring只是一个个类进行处理,如果为了加速,我们取消spring自带......
  • idea中的springboot项目如何重命名而不报错
    在IntelliJIDEA中重命名SpringBoot项目需要一些步骤,以确保项目在重命名后不会报错。以下是详细的步骤指南:1.重命名项目文件夹关闭项目:在IntelliJIDEA中关闭当前项目。重命名文件夹:在文件系统中找到项目所在的文件夹,右键重命名文件夹。重新打开项目:在IntelliJID......
  • springboot的服务不需要连接数据库,如何保证正常启动
    记个小笔记@SpringBootApplication(exclude=DataSourceAutoConfiguration.class)是一个SpringBoot应用程序中用来排除特定自动配置类的注解,一般情况不需要使用数据库,取消这个自动配置即可;如果你这样做了,发现还是出现FailedtoconfigureaDataSource:'url'attributeisn......
  • spring boot如何自定义注解
    总共分三步:1、创建一个注解importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;@Target(ElementType.METHOD)//注解的目标为方法@Retention(Retention......
  • Spring Boot —— Filter 过滤器
    目标实现一个自定义过滤器,在所有请求进来时输出点儿信息实现过滤器实现一个自定义过滤器,在所有请求进行业务处理前,在控制台输出请求Id和请求Url@Configuration@EnableWebMvcpublicclassWebConfiguration{publicstaticclassMyFilterimplementsFilter{......
  • Spring Boot —— Cors 跨域
    原理实现WebMvcConfigurer接口代码publicclassCorsConfigimplementsWebMvcConfigurer{@OverridepublicvoidaddCorsMappings(CorsRegistryregistry){registry//允许跨域访问的路径.addMapping("/**")......
  • Spring Boot —— 集成 Druid
    pom<dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-3-starter</artifactId><version>${druid.version}</version></dependency>application-develop.yamlspring:datasour......
  • Spring Boot —— 集成 MyBatis-Plus
    项目基于SpringBoot3.2.5Pom需要注意的是,引用Mybatis-Plus依赖,无需手动引入Mybatis<!--https://mvnrepository.com/artifact/com.mysql/mysql-connector-j--><dependency><groupId>com.mysql</groupId><artifactId>mysql-connector-j</......
  • Springboot Data Jdbc实体类json格式存储
    日常需求中有些需求需要在某字段存储json格式数据,例如日志审计接口传参数据等1.首先我们得保证数据库字段为text或者json2.设置读转换和写转换器importcom.fasterxml.jackson.databind.ObjectMapper;importorg.springframework.core.convert.converter.Converter;importo......
  • Spring是如何整合MyBatis将Mapper接口注册为Bean的原理
    一、接口生成bean定义1.首先MyBatis的Mapper接口核心是JDK动态代理2.Spring会排除接口,无法注册到IOC容器中3.MyBatis实现了BeanDefinitionRegistryPostProcessor可以动态注册BeanDefinition4.需要自定义扫描器(继承Spring内部扫描器ClassPathBeanDefinitionScan......