Swagger技术

介绍

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

官网:API Documentation & Design Tools for Teams | Swagger

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

使用方式:

1.导入knife4j的maven坐标

2.在配置类中加入knife4相关配置

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

复制代码
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
        </dependency>

  /**
     * 通过knife4j生成接口文档
     * @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.sky.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/");
    }

常用注解:

相关推荐
2301_763994711 分钟前
类和对象(下)
开发语言·c++
Dreamsi_zh3 分钟前
Python爬虫04_Requests豆瓣电影爬取
开发语言·爬虫·python
绿炮火11 分钟前
【MATLAB】(一)简介
开发语言·数学建模·matlab
超浪的晨12 分钟前
JavaWeb 进阶:Vue.js 与 Spring Boot 全栈开发实战(Java 开发者视角)
java·开发语言·前端·javascript·vue.js·html·个人开发
她说人狗殊途22 分钟前
Map 集合
java·开发语言·算法
EndingCoder1 小时前
Three.js + AI:结合 Stable Diffusion 生成纹理贴图
开发语言·前端·javascript·人工智能·stable diffusion·ecmascript·three.js
Chef_Chen1 小时前
从0开始学习R语言--Day62--RE插补
开发语言·学习·r语言
Dovis(誓平步青云)1 小时前
《C++二叉搜索树原理剖析:从原理到高效实现教学》
开发语言·c++·算法·二叉搜索树·原理剖析
hweiyu001 小时前
Scala实现常用排序算法
开发语言·排序算法·scala
rui锐rui1 小时前
claude code
开发语言