swagger快速使用

1. 添加Swagger到Maven项目的依赖项：

xml
<dependencies>
    <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>
</dependencies>

2. 配置Swagger：

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

在此示例中，我们配置Swagger以扫描 com.example.demo 包中的请求处理程序，并启用任何路径的Swagger文档。

3. 编写API接口和操作：

@RestController
@RequestMapping("/api")
public class UserController {
  
    @GetMapping("/users")
    public List<User> getUsers() {
        // 获取所有用户
    }
  
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // 创建新用户
    }
  
    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable(value = "id") long userId) {
        // 根据 ID 获取用户
    }
  
    @PutMapping("/users/{id}")
    public User updateUser(@PathVariable(value = "id") long userId, @RequestBody User userDetails) {
        // 更新用户信息
    }
  
    @DeleteMapping("/users/{id}")
    public void deleteUser(@PathVariable(value = "id") long userId) {
        // 删除用户
    }
}

这些操作处理与用户相关的API请求。

4. 启动应用程序并访问Swagger界面：

启动您的Spring Boot应用程序。在浏览器中输入以下网址： http://localhost:8080/swagger-ui.html 。您将看到Swagger UI界面。在这里，您可以看到API的列表，包括每个操作的详细信息。