Swagger配置

原创已于 2023-01-06 03:55:27 修改 · 852 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

于 2023-01-06 01:53:11 首次发布

Swagger 专栏收录该内容

1 篇文章

订阅专栏

文章介绍了如何在JavaMVC项目中使用knife4j集成Swagger来生成和优化API文档，包括添加pom依赖、配置Docket、设置静态资源映射、定义接口注解以及实体类注解，以便于接口调试和生成详细的接口文档，同时提到了Yapi的导入使用。

项目优化Day3-04-Swagger_介绍&使用方式&查看接口文档_哔哩哔哩_bilibili

1、引入pom依赖（knife4j是java MVC框架集成swagger生成api文档的增强解决方案）

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

2.导入knife4j相关配置

并在当前类下添加如下方法：

/**
 * 以下为swagger创建方法，为死代码，复制粘贴即可
 * @return
 */
@Bean
public Docket creatRestApi(){
    //文档类型
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.lmh.reggie.controller"))  
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
            .title("瑞吉外卖") 
            .version("1.0")
            .description("瑞吉外卖接口文档")
            .build();
}

3.静态资源映射（addResourceHandlers方法，否则接口文档页面无法访问，因为项目此时必须登录后才可访问资源）

registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");