Swager如何使用

大家好，欢迎来到IT知识分享网。

Swager是一个API文档自动生成工具，可以用于生成API接口文档，供开发者和用户查看和使用。它可以通过描述API接口的规范，自动生成API文档，使得API接口的发布和使用变得更加简单和规范。

下面是使用Swagger的步骤：

1. 首先，在你的项目中添加Swagger依赖。如果你是使用Maven构建项目，可以在pom.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>  

1. 然后，配置Swagger。在Spring Boot项目中，你可以创建一个Swagger配置类来配置Swagger。例如：

@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } }  

1. 在API接口类中添加Swagger注解。例如：

@RestController @RequestMapping("/users") @Api(value = "users", description = "Operations for users") public class UserController { @GetMapping("/{id}") @ApiOperation(value = "Get user by id", response = User.class) public User getUserById(@PathVariable Long id) { // your code here } }  

1. 最后，访问Swagger UI界面，查看生成的API文档。默认情况下，Swagger UI界面可以通过访问http://localhost:8080/swagger-ui.html来访问。

以上就是使用Swagger的基本步骤，你可以根据项目的需求进行定制化配置。