Spring Boot 3.x 配置 Spring Doc以及导入postman带图详解

2024/12/1 0:31:28 来源：https://blog.csdn.net/linsc_05/article/details/142443984 浏览: 次关键词：Spring Boot 3.x 配置 Spring Doc以及导入postman带图详解

一、pom.xml配置

<!-- API⽂档⽣成，基于swagger3 --><dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-ui</artifactId><version>2.0.2</version></dependency><dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-api</artifactId><version>2.0.2</version></dependency>

二、配置 yml 文件

server:port: 58080 # 指定端⼝号springdoc:api-docs:enabled: true # 开启OpenApi接口path: /v3/api-docs  # 自定义路径，默认为 "/v3/api-docs"swagger-ui:enabled: true # 开启swagger界面，依赖OpenApi，需要OpenApi同时开启path: /swagger-ui/index.html # 自定义路径，默认为"/swagger-ui/index.html"

后续访问的url端口号要通过配置的端口号来访问，如果没配置就是 8080。

三、SpringDocConfig文件配置

// 你自己的包名
package org.example.xxxx;import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class SpringDocConfig {@Beanpublic OpenAPI springShopOpenAPI() {return new OpenAPI().info(new Info().title("Spring Boot 中使用 Swagger UI 构建 RESTful API").contact(new Contact()).description("百草中医药信息管理平台提供的 RESTful API").version("v1.0.0").license(new License().name("Apache 2.0").url("http://springdoc.org"))).externalDocs(new ExternalDocumentation().description("外部文档").url("https://springshop.wiki.github.org/docs"));}
}