arrogancia de uso rápido

1. Agregue Swagger a las dependencias del proyecto 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. Configurar 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();                                           
    }
}

En este ejemplo, configuramos Swagger para escanear el paquete com.example.demo en busca de controladores de solicitudes y habilitar la documentación de Swagger para cualquier ruta.

3. Escriba la interfaz y la operación de la 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) {
    
    
        // 删除用户
    }
}

Estas operaciones manejan solicitudes de API relacionadas con el usuario.

4. Inicie la aplicación y acceda a la interfaz de Swagger:

Inicie su aplicación Spring Boot. Ingrese la siguiente URL en su navegador: http://localhost:8080/swagger-ui.html. Verá la interfaz de usuario de Swagger. Aquí puede ver una lista de API que incluye detalles para cada operación.