Как мне задокументировать параметр Rest, предоставляющий другой тип (MyClass или String)?

Question

В Springfox я однажды использовал следующий синтаксис для рендеринга параметра String с полной моделью ( исходный выпуск Github ):

@PatchMapping(path="/{objId}")
@ApiImplicitParams(@ApiImplicitParam(name="update", dataType="MyClass")) 
    public ApiResponse<MyClass> updateMyClassInst(@PathVariable String objId, @RequestBody String update) {

Причина этой формулировки в том, что если я поместил MyClass в качестве типа тела запроса, я не мог различить guish, когда свойство не было обновлено или когда было установлено значение null, потому что оба будут десериализованы до нулевого значения поля.

Как мне сделать это с помощью Springdo c?

Answer 1

Это эквивалентный код, использующий OpenAPI 3.

@PatchMapping(path="/{objId}")
@RequestBody( content = @Content(schema = @Schema(implementation = MyClass.class)))
public ApiResponse<MyClass> updateMyClassInst(@PathVariable String objId, @RequestBody String update) {
    return null;
}

Вы можете посмотреть руководство по миграции hte:

• https://springdoc.org/migrating-from-springfox.html

И документация по чванству:

• https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations