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

一、pom.xml配置

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 文件

XML 复制代码
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文件配置

java 复制代码
// 你自己的包名
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 {
    @Bean
    public 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"));
    }
}

四、访问

访问网址:localhost:58080/swagger-ui/swagger-ui/index.html#/

复制到浏览器访问,端口号需改成自己的

(我的是58080,复制记得改成自己的)

五、如何导入postman

然后在postman中操作

选择导入

然后就可以使用了~


相关推荐
拳打南山敬老院2 分钟前
漫谈 MCP 构建之概念篇
前端·后端·aigc
每天进步一点_JL18 分钟前
JVM 类加载:双亲委派机制
java·后端
用户298698530141 小时前
Java HTML 转 Word 完整指南
java·后端
渣哥1 小时前
原来公平锁和非公平锁差别这么大
java
渣哥1 小时前
99% 的人没搞懂:Semaphore 到底是干啥的?
java
J2K1 小时前
JDK都25了,你还没用过ZGC?那真得补补课了
java·jvm·后端
EMQX1 小时前
ESP32 + MCP over MQTT:通过大模型控制智能硬件设备
后端·mcp
郭京京1 小时前
go框架gin(中)
后端·go
郭京京1 小时前
go框架gin(下)
后端·go
kfyty7251 小时前
不依赖第三方,不销毁重建,loveqq 框架如何原生实现动态线程池?
java·架构