swagger入門
pom依賴
不用專門導入swagger 因為springboot已經將它集成了
org.springframework.boot spring-boot-starter com.github.xiaoymin knife4j-spring-boot-starterSwagger配置類
@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/");
}
}
注解效果
