Как использовать аннотации OAS3 для аннотирования методов RepositoryRestController? - PullRequest
Новая
       1

Как использовать аннотации OAS3 для аннотирования методов RepositoryRestController?

0 голосов
/ 19 февраля 2020

После добавления springdo c в наш проект Spring Framework 1.5 я могу просмотреть API в json. 

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-core</artifactId>
            <version>1.1.44</version>
        </dependency>

Но он не включает методы в нашем @ RepositoryRestController.

Предложено в ответе на spring-do c, я искал, как использовать @operation для аннотирования методов в контроллере покоя репозитория. Ниже приведен фрагмент кода: 

@Operation(description = "for creating registrations", method = "POST")
@ApiResponses(value = {
        @ApiResponse(responseCode = "201", description = "registration created",
                content = @Content(schema = @Schema(implementation = Registration.class)))
})
@PostMapping(value = "/registrations", consumes = MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public ResponseEntity<?> createRegistration(@RequestBody Registration requestBody){
// input validation and returning 201 and the created registration
    }

После добавления @operation я все еще не вижу конечную точку, включенную в документацию API.

Я также читаю сообщения об импорте @ javax.ws.rs.HTTP_METHOD, но я не могу просто импортировать его и использовать аннотацию @POST. С другой стороны, Spring Framework имеет свои собственные аннотации, которые использовались во всех контроллерах. Кажется, это не эффективный подход для замены текущих аннотаций в проекте аннотациями javax.

Я был бы признателен за то, чтобы узнать, как другие, использующие @RepositoryRestController, аннотируют свои пользовательские методы аннотациями OAS3.

...