swagger入门

swagger入门

pom依赖

不用专门导入swagger 因为springboot已经将它集成了
org.springframework.boot spring-boot-starter com.github.xiaoymin knife4j-spring-boot-starter

Swagger配置类

@Configuration

public class SwaggerConfig {

复制代码
// 创建并配置Docket Bean,用于生成Swagger文档
@Bean
public Docket docket() {
    // 创建API信息对象
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("我不饿外卖项目接口文档") // 设置文档标题
            .version("2.0") // 设置文档版本号
            .description("我不饿项目接口文档") // 设置文档描述
            .build();

    // 创建Docket对象
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo) // 设置API信息
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.sky.controller")) // 扫描指定包下的Controller类
            .paths(PathSelectors.any()) // 匹配所有路径
            .build();

    return docket; // 返回配置好的Docket对象
}

/**
 * 设置静态资源映射
 * @param registry
 */
// 重写addResourceHandlers方法,用于配置Swagger静态资源映射
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 添加映射规则,将/doc.html映射到classpath:/META-INF/resources/目录下
    registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
    // 添加映射规则,将/webjars/**映射到classpath:/META-INF/resources/webjars/目录下
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

}

注解效果







相关推荐
码云社区9 小时前
Java家政服务系统源码:人员技能、服务范围与多商家业务落地
java·开发语言·家政服务·家政小程序·家政系统
摇滚侠10 小时前
《On Java 中文版 基础卷》阅读笔记 接口 18
java·笔记·python
CoderYanger11 小时前
Java EE 进阶:9.MyBatis 操作数据库(进阶)(第八弹):MyBatis Generator
java·数据库·spring boot·spring·java-ee·tomcat·mybatis
jaysee-sjc13 小时前
【黑马点评】Day02:优惠券秒杀与分布式锁
java·分布式·nginx·spring·node.js·tomcat·maven
秋天的怀念_David14 小时前
算法一千零一夜 · 第三十五夜 · 恢复风暴
java·程序人生·算法
考虑考虑14 小时前
JDK27中的加密对象的 PEM 编码
java·后端·java ee
行者-全栈开发15 小时前
SpringBoot + GraalVM 原生编译实战:启动时间从8秒到0.5秒的极致优化
java·spring boot·后端
CoderYanger15 小时前
Java EE 进阶:10. MyBatis-Plus使用(第一弹)
java·spring boot·后端·sql·spring·java-ee·mybatis
大胖爱学习_MJ17 小时前
超越向量检索:用 Spring Boot + Neo4j 手搓 GraphRAG 知识图谱记忆
java·后端·python
吃我一窝jio17 小时前
Java博客极简写作三支柱
java