fix(swagger): 修正Knife4j配置并补充接口注解
- 更新扫描包路径为正确包名 com.yolo.keyborad.controller - 修正文档标题与项目名 keyborad-backend 保持一致 - 在 DemoController 添加 @Api 及 @ApiOperation 注解
This commit is contained in:
@@ -25,13 +25,13 @@ public class Knife4jConfig {
|
||||
public Docket defaultApi2() {
|
||||
return new Docket(DocumentationType.SWAGGER_2)
|
||||
.apiInfo(new ApiInfoBuilder()
|
||||
.title("project-backend")
|
||||
.description("project-backend")
|
||||
.title("keyborad-backend")
|
||||
.description("keyborad-backend")
|
||||
.version("1.0")
|
||||
.build())
|
||||
.select()
|
||||
// 指定 Controller 扫描包路径
|
||||
.apis(RequestHandlerSelectors.basePackage("com.yupi.project.controller"))
|
||||
.apis(RequestHandlerSelectors.basePackage("com.yolo.keyborad.controller"))
|
||||
.paths(PathSelectors.any())
|
||||
.build();
|
||||
}
|
||||
|
||||
@@ -2,6 +2,10 @@ package com.yolo.keyborad.controller;
|
||||
|
||||
import com.yolo.keyborad.common.BaseResponse;
|
||||
import com.yolo.keyborad.common.ResultUtils;
|
||||
import io.swagger.annotations.Api;
|
||||
import io.swagger.annotations.ApiOperation;
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.web.bind.annotation.CrossOrigin;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
@@ -16,11 +20,12 @@ import org.springframework.web.bind.annotation.RestController;
|
||||
@RequestMapping("/demo")
|
||||
@Slf4j
|
||||
@CrossOrigin
|
||||
@Api(tags = "测试控制器")
|
||||
public class DemoController {
|
||||
|
||||
@GetMapping("/test")
|
||||
public BaseResponse<String> hostsInfo(){
|
||||
|
||||
@ApiOperation("测试接口")
|
||||
public BaseResponse<String> testDemo(){
|
||||
return ResultUtils.success("hello world");
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user