swagger3生成接口文档
时间: 2023-11-27 14:46:37 浏览: 138
swagger 接口文档
Swagger是一种API文档生成工具,可以帮助开发人员自动生成API文档。Swagger3是Swagger的最新版本,它提供了更多的功能和更好的用户体验。下面是使用Swagger3生成接口文档的步骤:
1.在pom.xml文件中添加Swagger3的依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
2.添加Swagger配置类:
```java
@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API文档")
.description("这是一个API文档示例")
.version("1.0.0")
.build();
}
}
```
3.在Controller中添加Swagger接口注解:
```java
@RestController
@RequestMapping("/api")
@Api(tags = "用户管理")
public class UserController {
@GetMapping("/users")
@ApiOperation("获取用户列表")
public List<User> getUsers() {
// ...
}
@PostMapping("/users")
@ApiOperation("创建用户")
public void createUser(@RequestBody User user) {
// ...
}
@GetMapping("/users/{id}")
@ApiOperation("获取用户信息")
public User getUserById(@PathVariable Long id) {
// ...
}
@PutMapping("/users/{id}")
@ApiOperation("更新用户信息")
public void updateUser(@PathVariable Long id, @RequestBody User user) {
// ...
}
@DeleteMapping("/users/{id}")
@ApiOperation("删除用户")
public void deleteUser(@PathVariable Long id) {
// ...
}
}
```
4.启动应用程序并访问http://localhost:8080/swagger-ui/index.html,即可查看和测试接口。
阅读全文