苍穹外卖swagger

shangxianjiao

已于 2024-03-19 00:07:08 修改

阅读量413

点赞数 9

文章标签：苍穹外卖 swagger Java

于 2024-03-18 01:49:58 首次发布

本文链接：https://blog.csdn.net/shangxianjiao/article/details/136794505

版权

本文介绍了如何在SpringBoot项目中配置Knife4j，创建API接口文档，包括Swagger配置类的详细代码，如设置标题、版本和联系信息等。

摘要由CSDN通过智能技术生成

在这里插入图片描述

在这里插入图片描述
其他项目也这样用

在这里插入图片描述

注意用法

@Api(tags = "员工管理")
public class EmployeeController 

@ApiOperation("登录")

swagger配置类代码



@Configuration
public class SwaggerConfig {

    /**
     * 通过knife4j生成接口文档
     *
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }


}

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

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



@Configuration
@EnableSwagger2
@EnableKnife4j
public class Knife4jConfig {

    /**
     * 创建api
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .select()
                // api接口扫包范围
                .apis(RequestHandlerSelectors.basePackage("com.controller"))
                .paths(PathSelectors.any())
                .build();

    }

    /**
     * 配置api信息
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .description("学习Java")
                .contact(new Contact("zhangsan", "https://XXX.com", "zhangsan"))
                .version("v1.1.0")
                .title("API测试文档")
                .build();
    }

}