Swagger生成接口文档

let_

于 2024-08-08 10:30:00 发布

阅读量519

点赞数 8

分类专栏： Spring 文章标签：开发语言 spring boot mybatis java 安全数据库架构阿里云

本文链接：https://blog.csdn.net/weixin_73253843/article/details/140939042

版权

Spring 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

一、介绍

二、使用方式

三、常用注解

纯干货，0废话。。

一、介绍

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就能做到生成接口文档，以及在线接口调试页面。

https://swagger.io/https://swagger.io/

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

二、使用方式

固定代码，扫描到的controller改成自己的

@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    /**
     * 生成接口文档配置
     * @return
     */
    @Bean
    public Docket docket(){
        log.info("准备生成接口文档...");

        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("接口文档")
                .version("2.0")
                .description("接口文档")
                .build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                //指定生成接口需要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.itheima.controller"))
                .paths(PathSelectors.any())
                .build();

        return docket;
    }

    /**
     * 设置静态资源映射
     * @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/");
    }
}

访问路径：http://localhost:8080/doc.html（端口号取决于你项目的端口号）