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/");
}

}

注解效果







相关推荐
Jerry&Grj19 分钟前
SpringBoot埋点功能技术实现方案深度解析:架构设计、性能优化与扩展性实践
java·微服务·性能优化·springboot·架构设计·埋点技术
没有bug.的程序员25 分钟前
Redis Stream:轻量级消息队列深度解析
java·数据库·chrome·redis·消息队列
用户8160791833331 小时前
告别“魔法”:包你解决 Gradle 的下载慢问题
java
当归10241 小时前
SQL Server死锁排查实战指南
java·服务器·网络
echoyu.2 小时前
消息队列-初识kafka
java·分布式·后端·spring cloud·中间件·架构·kafka
little_xianzhong2 小时前
关于对逾期提醒的定时任务~改进完善
java·数据库·spring boot·spring·mybatis
百锦再2 小时前
脚本语言的大浪淘沙或百花争艳
java·开发语言·人工智能·python·django·virtualenv·pygame
小猪咪piggy2 小时前
【JavaEE】(23) 综合练习--博客系统
java·数据库·java-ee
周航宇JoeZhou2 小时前
JP4-7-MyLesson后台前端(五)
java·前端·vue·elementplus·前端项目·mylesson·管理平台
David爱编程2 小时前
从 JVM 到内核:synchronized 与操作系统互斥量的深度联系
java·后端