投票项目_使knife4j生成接口文档

最新推荐文章于 2024-05-18 11:09:56 发布

柚＆.屿づ

最新推荐文章于 2024-05-18 11:09:56 发布

阅读量158

点赞数 3

分类专栏：投票项目文章标签： java springboot

本文链接：https://blog.csdn.net/qq_63997064/article/details/136307830

版权

投票项目专栏收录该内容

6 篇文章 0 订阅

订阅专栏

1. 导入依赖

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

2. 创建配置类

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
//@EnableSwagger2WebMvc
@Slf4j
public class Knife4jConfig {

    @Bean
    public Docket createRestApi() {
        log.info("=================================");
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.votedemo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        log.info("----------------------------------");
        return new ApiInfoBuilder()
                .title("SpringBoot项目 后台服务API接口文档")
                .description("使用 knife4j 搭建的后台服务API接口文档")
                .termsOfServiceUrl("http://localhost:8080/")
                .version("1.0.0")
                .build();
    }
}

3. 使用

在Controller类名上加@Api注解

在接口名上加@ApiOperation注解

在http://localhost:8080/doc.html