SpringBoot3 integrate SpringDoc

MyFreeIT

已于 2023-05-08 19:42:18 修改

阅读量947

点赞数

CC 4.0 BY-SA版权

分类专栏： Spring 文章标签： Springdoc Springboot

于 2023-05-08 16:31:26 首次发布

创作源自于MyFreeIT

本文链接：https://blog.youkuaiyun.com/MyFreeIT/article/details/130561260

Spring 专栏收录该内容

46 篇文章

订阅专栏

文章介绍了如何使用SpringDoc替换Swagger2来管理和文档化API。首先，通过在pom.xml中引入springdoc-openapi-starter-webmvc-ui依赖，然后利用@OpenAPIDefinition注解声明OpenAPI。接着，通过@GroupedOpenApi将API分组，如restApi和helloApi，并定义了访问路径。最后，配置Springdoc的设置，允许通过/sdk访问文档，并提供了默认的访问URL。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringDoc 官方文档

Springdoc3取代swagger2

pom xml加载Springdoc Jar

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

因为是spring-boot-starter-web项目，所以使用springdoc-openapi-starter-webmvc-ui。
需要根据项目类型选择对应的Dependency，否则表现为404 错误。

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.1.0</version>
   </dependency>

@OpenAPIDefinition，声明一个OpenAPI

@OpenAPIDefinition
@Configuration
public class OpenApiConfig {
	  @Bean
	  public OpenAPI springOpenApi() {
	      return new OpenAPI()
	              .info(new Info().title("This is SpringTest API")
	              .description("Regarding this API to develop mobile application")
	              .version("v1"));
	  }
}

对API进行分组，方便查询

	  @Bean
	  public GroupedOpenApi orderApi() {
		  return GroupedOpenApi.builder().group("restApi").pathsToMatch("/rest/**").build();
	  }
	  @Bean
	  public GroupedOpenApi helloApi() {
		  return GroupedOpenApi.builder().group("helloApi").pathsToMatch("/hello/**").build();
	  }

访问地址

http://localhost:8081/swagger-ui/index.html
or
http://localhost:8081/v3/api-docs

在这里插入图片描述

springdoc Configuration

通过/sdk访问doc，不过Springdoc会自动到/swagger-ui/index.html

springdoc:
  api-docs:
#Default enabled: true
    enabled: true
  swagger-ui:
#defalut path = /swagger-ui/index.html
    path: /sdk

@RequestMapping

@RequestMapping("/hello")，如果不指定RequestMethod,
通过Get,Post,Put,Delete,Options,Head,Patch都可以访问。
and
@RequestMapping(value="/hello",method=RequestMethod.GET)

在这里插入图片描述