Что такое Swagger

Swagger — это набор инструментов для проектирования, документирования и тестирования RESTful API. Основной компонент — Swagger UI, который визуализирует API в интерактивной форме, позволяя разработчикам отправлять запросы прямо из браузера.

Ключевые возможности:

• Автогенерация документации на основе аннотаций в коде.
• Интерактивное тестирование API без Postman.
• Поддержка OpenAPI (стандарт описания API).

Пример аннотации в Spring Boot:

@RestController
@RequestMapping("/api")
@Api(tags = "User API")
public class UserController {
    @GetMapping("/users/{id}")
    @ApiOperation("Get user by ID")
    public User getUser(@PathVariable Long id) {
        return userService.findById(id);
    }
}

Как подключить:

1. Добавить зависимость springfox-boot-starter (для Spring Boot).
2. Настроить конфигурацию Swagger через @EnableSwagger2.
3. Доступ к документации — /swagger-ui.html.

Swagger упрощает взаимодействие между фронтендом и бэкендом, сокращая время на согласование форматов запросов/ответов.