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

}

注解效果







相关推荐
草莓熊Lotso几秒前
《算法闯关指南:优选算法--二分查找》--19.x的平方根,20.搜索插入位置
java·开发语言·c++·算法
YJlio4 分钟前
Process Monitor 学习笔记(5.7):长时间运行追踪与日志文件体积的控制
java·笔记·学习
失散137 分钟前
分布式专题——45 ElasticSearch基础数据管理详解
java·分布式·elasticsearch·架构
没有bug.的程序员7 分钟前
分布式监控体系:从指标采集到智能告警的完整之道
java·分布式·告警·监控体系·指标采集
想不明白的过度思考者24 分钟前
JavaEE初阶——TCP/IP协议栈:从原理到实战
java·网络·网络协议·tcp/ip·java-ee
好家伙VCC43 分钟前
**发散创新:渗透测试方法的深度探索与实践**随着网络安全形势日益严峻,渗透测试作为评估系统安全的
java·python·安全·web安全·系统安全
白萤1 小时前
SpringBoot用户登录注册系统设计与实现
java·spring boot·后端
练习时长一年1 小时前
@Scope失效问题
java·开发语言
摇滚侠4 小时前
Spring Boot 3零基础教程,创建第一个 Spring Boot 3 应用,Spring Boot 3 外部配置,笔记03
java·spring boot·笔记
没有bug.的程序员6 小时前
服务网格 Service Mesh:微服务通信的终极进化
java·分布式·微服务·云原生·service_mesh