chaoyangnz / patchable

Ease the API Patch implementation in Spring Boot and Micronaut

Patch support

Install

Gradle:

implementation 'patchable:patchable-micronaut:1.0.0

Usage

Configure a bean

@Factory
public class PatchableFactory {
    @Inject
    private ObjectMapper objectMapper;

    @Singleton
    public PatchInfoRequestBinder patchInfoRequestBinder() {
        return new PatchInfoRequestBinder(objectMapper);
    }
}

Define models

@Introspected
@Getter @Setter
class Book {
    @NotNull
    private Long id;
    @NotNull
    @Size(min = 10)
    private String name;
    @Patchable
    @NotNull
    private String description;
}

@Introspected
@Getter @Setter
class BookToPatch {
    @NotNull
    private String description;
}

Bind PatchInfo in controller

@Controller
@Validated
public class BookController {

    @Inject
    private BookRepository bookRepository;

    @Patch("/{id}")
    public Book patch(
        @NotNull Long id, 
        @Valid PatchInfo<BookToPatch, Book> patchInfo
    ) {
        Book book = bookRepository.findById(id);
        return bookRepository.save(patchInfo.merge(book));
    }
}