springboot2.7.10集成swagger3.0

最新推荐文章于 2024-07-27 13:06:23 发布

原创最新推荐文章于 2024-07-27 13:06:23 发布 · 1.4k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #mybatis #开发语言

本文展示了如何在Java项目中添加Springfox依赖以生成SwaggerAPI文档。首先，引入了Springfox-boot-starter的依赖，然后创建了一个配置类SwaggerConfig，定义了Docketbean来指定API的包路径和信息。配置还包括了作者Contact信息以及ApiInfo，最后提供了访问SwaggerUI的URL。

添加依赖

<!--swagger依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

增加配置类

package com.zeitor.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;

/**
 * @Author 逐鹿艾缇
 * @Description 配置类
 * @Date 2023/3/29 9:14
 * @Version 1.0
 */

@Configuration
public class SwaggerConfig {
    //配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(" com.zeitor.controller"))
                .build();
    }

    //作者信息
    Contact contact = new Contact("zeit", "zeitor.cn", "936618343@qq.com");

    //配置Swagger 信息 = ApiInfo
    private ApiInfo apiInfo() {
        return new ApiInfo("智能人模的Api文档",
                "好好看文档",
                "1.0",
                "zeitor.cn",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }
}