用Swagger生成api接口文档和在线接口调试页面

WentyC

已于 2024-03-09 17:01:58 修改

阅读量497

点赞数 7

分类专栏： javaweb学习笔记文章标签：开发语言 java

于 2024-03-09 16:57:57 首次发布

本文链接：https://blog.csdn.net/chengougoutour/article/details/136586565

版权

javaweb学习笔记专栏收录该内容

7 篇文章 0 订阅

订阅专栏

黑马程序员-《苍穹外卖》-学习笔记：

直接用swagger是比较繁琐的

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案

1.导入knife4j的maven坐标：

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

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

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

3、设置静态资源映射，否则接口文档页面无法访问

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