Questão de TI - Desenvolvimento de Sistemas — Documentação de APIs (Swagger e OpenAPI) — FCC 2025
TI - Desenvolvimento de SistemasDocumentação de APIs (Swagger e OpenAPI)
- Código
- fc150459
- Banca
- FCC
- Órgão
- TRF 4
- Ano
- 2025
- Cargo
- TJ TRF4
Uma analista está trabalhando em uma API Spring Boot e precisa documentar os endpoints utilizando anotações do Swagger para descrever operações, parâmetros e respostas. Ela quer garantir que a documentação seja clara e compatível com a especificação OpenAPI 3.0, mas está incerta sobre qual conjunto de anotações usar e como aplicá-las corretamente em um controlador. O endpoint em questão é um GET /processos/(id) que retorna os detalhes de um processo. Nesse cenário, a maneira correta de anotar o endpoint GET /processos/(id) em um controlador Spring Boot para garantir uma documentação precisa e compatível com OpenAPI 3.0, usando a biblioteca springdoc-openapi, é usar
- A@Apioperation e @ApiParam do pacote io.swagger.annotations para descrever a operação e o parâmetro.
- B@ApiResponse do pacote io.swagger.annotations combinado com @Operation do pacote io.swagger.v3.oas.annotations .
- Capenas @GetMapping sem anotaçoes do Swagger, pois springdoc-openapi gera documentação automaticamente.
- D@Schema no método do controlador para descrever o parâmetro (id) .
- E@Operation e @Parameter do pacote io.swagger.v3.oas.annotations para descrever a operação e o parâmetro.