Questão FC373741
Para documentar uma API acessível externamente a partir de um cenário de microsserviços, um Analista utilizou a especificação Swagger. Para cada operação RESTful na API, ele adicio
Swagger (Documentação de APIs)
FCC · 2022
Para documentar uma API acessível externamente a partir de um cenário de microsserviços, um Analista utilizou a especificação Swagger. Para cada operação RESTful na API, ele adicionou uma anotação A, juntamente com anotações B no método Java correspondente, para descrever a operação e suas respostas de erro esperadas. As anotações A e B são, respectivamente,
- @describeOperation e @errorResponse.
- @restOperation e @restResponse.
- @getInfoOperation e @getErrorResponse.
- @ApiOperation e @ApiResponse.
- @swaggerOperation e @swaggerResponse.
Mostrar resposta e comentário
Gabarito
D
Comentário do professor
Swagger em Java fornece anotações para gerar documentação automática das operações REST. Para descrever cada operação usa-se a anotação @ApiOperation, aplicada ao método do controller para informar resumo, descrição e metadados da ação HTTP.
As respostas esperadas — incluindo códigos de status, mensagens e, opcionalmente, o modelo de retorno — são documentadas com @ApiResponse. Várias respostas podem ser agrupadas via @ApiResponses quando necessário.
Na prática, anota-se o método Java com @ApiOperation e adiciona-se uma ou mais @ApiResponse para listar sucessos e erros previstos. Essas informações alimentam a interface gerada (por exemplo, Swagger UI), ajudando consumidores externos a entenderem contratos e tratamentos de erro.
Conteúdo do catálogo FC Concursos · Atualizado em