springboot自动生成接口文档
时间: 2023-01-11 12:55:36 浏览: 164
springboot接口开发
Spring Boot 支持使用 Swagger 来自动生成接口文档。Swagger 是一个用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的工具。
要使用 Swagger 生成 Spring Boot 项目的接口文档,需要在项目中添加 Swagger 的依赖,然后在项目的启动类上添加 `@EnableSwagger2` 注解。
例如:
```
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
```
然后,可以在接口方法上添加 Swagger 的注解来描述接口信息,例如:
```
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
@Api(value = "测试接口", tags = "测试接口相关操作")
public class TestController {
@ApiOperation(value = "测试接口", notes = "测试接口的描述信息")
@GetMapping("/test")
public String test() {
return "test";
}
}
```
最后,在浏览器中访问 `http://localhost:8080/swagger-ui.html` 即可看到自动生成的接口文档。
阅读全文