springboot整合swagger2步骤demo
时间: 2023-04-05 12:02:28 浏览: 165
您好,以下是springboot整合swagger2的步骤demo:
1. 在pom.xml文件中添加swagger2的依赖:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 创建Swagger2配置类,用于配置Swagger2相关信息:
```
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("更多Spring Boot相关文章请关注:http://www.example.com/")
.termsOfServiceUrl("http://www.example.com/")
.contact("example")
.version("1.0")
.build();
}
}
```
3. 在Controller类中添加Swagger2注解,用于描述接口信息:
```
@RestController
@RequestMapping("/user")
@Api(tags = "用户管理")
public class UserController {
@ApiOperation(value = "获取用户列表", notes = "获取所有用户列表")
@GetMapping("/list")
public List<User> list() {
// ...
}
@ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
@ApiImplicitParam(name = "user", value = "用户实体", required = true, dataType = "User")
@PostMapping("/create")
public String create(@RequestBody User user) {
// ...
}
@ApiOperation(value = "更新用户", notes = "根据User对象更新用户")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
@ApiImplicitParam(name = "user", value = "用户实体", required = true, dataType = "User")
})
@PutMapping("/update/{id}")
public String update(@PathVariable Long id, @RequestBody User user) {
// ...
}
@ApiOperation(value = "删除用户", notes = "根据ID删除用户")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
@DeleteMapping("/delete/{id}")
public String delete(@PathVariable Long id) {
// ...
}
}
```
4. 启动应用程序,访问http://localhost:8080/swagger-ui.html,即可查看Swagger2生成的接口文档。
希望对您有所帮助!
阅读全文