生成spring的api文档
时间: 2023-06-12 09:06:29 浏览: 98
要生成Spring API文档,可以使用Spring框架中的Springfox库。Springfox库提供了一种自动生成API文档的简单方法,该文档基于Spring MVC控制器和Spring RESTful注释。
以下是一些步骤:
1. 添加Springfox依赖项到项目中:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 在Spring配置文件中启用Swagger注解:
```java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
```
3. 在控制器方法上添加Swagger注释:
```java
@RestController
public class UserController {
@ApiOperation(value = "Get all users")
@GetMapping("/users")
public List<User> getAllUsers() {
// ...
}
@ApiOperation(value = "Get user by ID")
@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
// ...
}
// ...
}
```
4. 启动应用程序并访问Swagger UI:
```
http://localhost:8080/swagger-ui.html
```
在Swagger UI中,您可以查看API文档并测试各个端点。