下面是 "Knife4j 3.0.3 整合 SpringBoot 2.6.4 的详细过程":
首先,需要确保我们的项目中已经添加了 SpringBoot 2.6.4 的依赖。可以在 pom.xml 文件中添加以下依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.6.4</version>
</dependency>
接着,我们需要在 pom.xml 文件中添加 Knife4j 的依赖,具体如下:
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
完成依赖添加后,在项目的配置类中添加 Knife4j 的配置,具体如下:
@Configuration
public class Knife4jConfig {
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("示例API")
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("示例API文档")
.description("这是示例API文档")
.version("1.0")
.build();
}
}
其中,groupname 表示生成的 API 文档的分组名称,apis 表示需要生成 API 文档的 controller 包路径,apiInfo 表示生成的 API 文档的信息。
最后,在应用启动类上添加注解 @EnableSwagger2Doc,如下:
@SpringBootApplication
@EnableSwagger2Doc
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
至此,Knife4j 3.0.3 整合 SpringBoot 2.6.4 的过程就完成了。
下面展示两个示例:
- 对于 get 请求,我们的请求参数需要以字符串形式出现,如下:
@GetMapping("/hello")
@ApiOperation("示例接口")
@ApiImplicitParam(name = "name", value = "用户姓名", required = true, paramType = "query")
public String sayHello(@RequestParam("name") String name) {
return "Hello, " + name;
}
- 对于 post 请求,我们需要传入一个 json 值,如下:
@PostMapping("/user")
@ApiOperation("示例接口")
@ApiImplicitParam(name = "user", value = "用户信息", required = true, dataType = "User")
public Result addUser(@RequestBody User user) {
return userService.add(user);
}
其中,User 是一个具体的 JavaBean,表示我们需要传入的用户信息。
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:Knife4j 3.0.3 整合SpringBoot 2.6.4的详细过程 - Python技术站