Spring Boot: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/test")
@Api(value = "测试接口", tags = "测试接口", description = "用于测试Swagger集成")
public class TestController {
@GetMapping("/hello")
@ApiOperation(value = "测试方法", notes = "用于测试Swagger生成的接口文档")
public String hello() {
return "Hello, Swagger!";
}
}
这段代码演示了如何在Spring Boot项目中使用Swagger注解来生成RESTful API的接口文档。通过@Api
和@ApiOperation
注解,你可以描述你的控制器和方法,使得Swagger能够为你的接口生成清晰的API文档。这有助于开发者理解接口的用途和如何使用它们,从而提高团队合作效率。
评论已关闭