swagger在java中的基本使用

最新推荐文章于 2025-02-27 13:18:29 发布

四矢

最新推荐文章于 2025-02-27 13:18:29 发布

阅读量602

点赞数 10

分类专栏： Java 文章标签： java 开发语言

本文链接：https://blog.youkuaiyun.com/qxjswl/article/details/136405106

版权

Java 专栏收录该内容

28 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中集成Knife4j库，通过配置类自动生成API文档，并提供了一个示例。通过`@Bean`注解配置Docket来指定接口扫描路径，最后用户可以通过`http://localhost:8080/doc.html`访问生成的Swagger文档。

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

自动生成接口文档，和在线接口测试的框架。

导入依赖

<!--            knife4j对swagger进行一个封装-->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>3.0.2</version>
            </dependency>

在配置类中加入 knife4j相关配置


/**
 * 配置类，注册web层相关组件
 */
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("xxx目接口文档")
                .version("2.0")
                .description("xxx目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller")) //指定要扫描的controller包的位置
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}