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

}

注解效果







相关推荐
FrankYoou41 分钟前
Jenkins 与 GitLab CI/CD 的核心对比
java·docker
麦兜*1 小时前
Spring Boot启动优化7板斧(延迟初始化、组件扫描精准打击、JVM参数调优):砍掉70%启动时间的魔鬼实践
java·jvm·spring boot·后端·spring·spring cloud·系统架构
KK溜了溜了1 小时前
JAVA-springboot 整合Redis
java·spring boot·redis
天河归来2 小时前
使用idea创建springboot单体项目
java·spring boot·intellij-idea
weixin_478689762 小时前
十大排序算法汇总
java·算法·排序算法
码荼2 小时前
学习开发之hashmap
java·python·学习·哈希算法·个人开发·小白学开发·不花钱不花时间crud
IT_10242 小时前
Spring Boot项目开发实战销售管理系统——数据库设计!
java·开发语言·数据库·spring boot·后端·oracle
ye903 小时前
银河麒麟V10服务器版 + openGuass + JDK +Tomcat
java·开发语言·tomcat
武昌库里写JAVA3 小时前
Oracle如何使用序列 Oracle序列使用教程
java·开发语言·spring boot·学习·课程设计
做题不NG4 小时前
大模型应用开发-LangChain4j
java