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

}

注解效果







相关推荐
都叫我大帅哥28 分钟前
深入浅出 Resilience4j:Java 微服务的“免疫系统”实战指南
java·spring cloud
Cao_Shixin攻城狮3 小时前
Flutter运行Android项目时显示java版本不兼容(Unsupported class file major version 65)的处理
android·java·flutter
Dcs5 小时前
还在用 Arrays.hashCode?Java 自己也能写出更快的版本!
java
fouryears_234177 小时前
Spring,Spring Boot 和 Spring MVC 的关系以及区别
java·spring boot·spring·mvc
阿葱(聪)8 小时前
java 在k8s中的部署流程
java·开发语言·docker·kubernetes
浮生带你学Java8 小时前
2025Java面试题及答案整理( 2025年 7 月最新版,持续更新)
java·开发语言·数据库·面试·职场和发展
板板正8 小时前
SpringAI——提示词(Prompt)、提示词模板(PromptTemplate)
java·spring boot·ai·prompt
板板正8 小时前
SpringAI——对话记忆
java·spring boot·ai
期待のcode8 小时前
图片上传实现
java·前端·javascript·数据库·servlet·交互
李长渊哦9 小时前
深入理解Java中的Map.Entry接口
java·开发语言