首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

使用Springdoc启动时将SwaggerUI路径/url打印到控制台

Springdoc是一个用于生成和展示API文档的开源库,它基于Spring Boot和Swagger实现。使用Springdoc启动时将SwaggerUI路径/url打印到控制台的方法如下:

  1. 首先,确保你的项目中已经引入了Springdoc的依赖。可以在项目的pom.xml文件中添加以下依赖:
代码语言:txt
复制
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.10</version>
</dependency>
  1. 在Spring Boot的启动类上添加@EnableSwagger2注解,启用Swagger支持。
代码语言:txt
复制
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class YourApplication {

    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}
  1. 在应用程序启动后,可以通过访问http://localhost:8080/swagger-ui.html来查看SwaggerUI界面。这是Springdoc默认的SwaggerUI路径。
  2. 如果你想在启动时将SwaggerUI路径打印到控制台,可以在启动类中添加一个CommandLineRunner的Bean,并在其run方法中获取SwaggerUI路径并打印出来。
代码语言:txt
复制
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;

import java.util.List;

@Component
public class SwaggerUrlPrinter implements CommandLineRunner {

    private final SwaggerResourcesProvider swaggerResourcesProvider;

    public SwaggerUrlPrinter(SwaggerResourcesProvider swaggerResourcesProvider) {
        this.swaggerResourcesProvider = swaggerResourcesProvider;
    }

    @Override
    public void run(String... args) {
        List<SwaggerResource> resources = swaggerResourcesProvider.get();
        for (SwaggerResource resource : resources) {
            System.out.println("SwaggerUI URL: " + resource.getUrl());
        }
    }
}

以上代码中,我们通过注入SwaggerResourcesProvider来获取SwaggerUI的URL,并将其打印到控制台。

注意:以上代码中的URL路径和端口号可能需要根据你的实际情况进行修改。

推荐的腾讯云相关产品和产品介绍链接地址:

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

没有搜到相关的视频

领券