Для OpenAPI 3.0 и Spring Boot существует несколько аннотаций, которые вы можете использовать для определения и документирования вашего API. Эти аннотации помогают генерировать спецификацию OpenAPI и предоставляют информацию о конечных точках API, телах запросов/ответов, параметрах и т. д. Вот некоторые часто используемые аннотации:
-
@RestController: эта аннотация используется для определения класса как контроллера RESTful в Spring Boot. -
@RequestMapping: эта аннотация используется для сопоставления HTTP-запросов с конкретными методами обработчика. С помощью этой аннотации вы можете указать метод запроса, URL-адрес конечной точки и другие параметры. -
@GetMapping,@PostMapping,@PutMapping,@DeleteMapping: эти аннотации являются ярлыками для@RequestMappingс помощью определенных методов HTTP (GET, POST, PUT, DELETE) соответственно. -
@PathVariable: эта аннотация используется для извлечения значений из URL-пути и привязки их к параметрам метода. -
@RequestParam: эта аннотация используется для извлечения значений из параметров запроса в URL-адресе и привязки их к параметрам метода. -
@RequestBody: эта аннотация используется для привязки тела запроса к параметру метода. Он часто используется для обработки полезных данных JSON или XML. -
@ApiResponse: эта аннотация используется для документирования ответа на операцию API. С помощью этой аннотации вы можете указать код ответа HTTP, описание и схему ответа. -
@ApiParam: эта аннотация используется для документирования параметров операции API. Он позволяет указать имя параметра, описание, тип данных и другие атрибуты. -
@ApiOperation: эта аннотация используется для предоставления дополнительной информации об операции API. С помощью этой аннотации вы можете указать сводку, описание и другие сведения об операции. -
@Api
Эти аннотации можно использовать в сочетании для определения и документирования конечных точек API в приложении Spring Boot с OpenAPI 3.0.