Add OPEN API / DTO generation

pom.xml

@@ -19,11 +19,16 @@
 
     <properties>
         <spring-data-jdbc.version>1.2.1.RELEASE</spring-data-jdbc.version>
-        <springfox-swagger.version>2.9.2</springfox-swagger.version>
+        <springfox-swagger.version>3.0.0</springfox-swagger.version>
         <jacoco.version>0.8.5</jacoco.version>
-
         <docker.jib-maven-plugin.version>1.3.0</docker.jib-maven-plugin.version>
         <docker.image.prefix>springcommunity</docker.image.prefix>
+        <jsr305.version>3.0.2</jsr305.version>
+        <jackson-databind-nullable.version>0.2.1</jackson-databind-nullable.version>
+        <mapstruct.version>1.4.1.Final</mapstruct.version>
+        <jaxb-api.version>2.3.0</jaxb-api.version>
+        <openapi-generator-maven-plugin.version>5.2.1</openapi-generator-maven-plugin.version>
+        <build-helper-maven-plugin.version>3.2.0</build-helper-maven-plugin.version>
     </properties>
 
     <dependencies>
@@ -123,16 +128,26 @@
             <artifactId>json-path</artifactId>
             <scope>test</scope>
         </dependency>
-
         <dependency>
             <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger2</artifactId>
+            <artifactId>springfox-boot-starter</artifactId>
             <version>${springfox-swagger.version}</version>
         </dependency>
+
         <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger-ui</artifactId>
-            <version>${springfox-swagger.version}</version>
+            <groupId>org.openapitools</groupId>
+            <artifactId>jackson-databind-nullable</artifactId>
+            <version>${jackson-databind-nullable.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mapstruct</groupId>
+            <artifactId>mapstruct</artifactId>
+            <version>${mapstruct.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mapstruct</groupId>
+            <artifactId>mapstruct-processor</artifactId>
+            <version>${mapstruct.version}</version>
         </dependency>
 
         <dependency>
@@ -144,7 +159,7 @@
         <dependency>
             <groupId>javax.xml.bind</groupId>
             <artifactId>jaxb-api</artifactId>
-            <version>2.3.0</version>
+            <version>${jaxb-api.version}</version>
         </dependency>
     </dependencies>
 
@@ -234,7 +249,90 @@
                     </to>
                 </configuration>
             </plugin>
+
+
+            <plugin>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <!-- RELEASE_VERSION -->
+                <version>${openapi-generator-maven-plugin.version}</version>
+                <!-- /RELEASE_VERSION -->
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                        <configuration>
+                            <inputSpec>${project.basedir}/src/main/resources/api-docs.yml</inputSpec>
+                            <modelPackage>org.springframework.samples.petclinic.dto</modelPackage>
+                            <generatorName>spring</generatorName>
+                            <library>spring-boot</library>
+
+                            <!-- Only enabling model generation -->
+                            <modelNameSuffix>Dto</modelNameSuffix>
+                            <generateApiTests>false</generateApiTests>
+                            <generateModelDocumentation>false</generateModelDocumentation>
+                            <generateModelTests>false</generateModelTests>
+                            <generateApis>false</generateApis>
+                            <generateApiDocumentation>false</generateApiDocumentation>
+                            <generateModels>true</generateModels>
+                            <generateSupportingFiles>false</generateSupportingFiles>
+                            <!-- Activating JAVA8 features -->
+                            <configOptions>
+                                <performBeanValidation>true</performBeanValidation>
+                                <dateLibrary>legacy</dateLibrary>
+                                <java8>true</java8>
+                                <openApiNullable>false</openApiNullable>
+                                <serializationLibrary>jackson</serializationLibrary>
+                            </configOptions>
+                            <!-- override the default library to jersey2 -->
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>build-helper-maven-plugin</artifactId>
+                <version>${build-helper-maven-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <id>add-source</id>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>add-source</goal>
+                        </goals>
+                        <configuration>
+                            <sources>
+                                <source>target/generated-sources/openapi/src/main/java</source>
+                            </sources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>org.mapstruct</groupId>
+                            <artifactId>mapstruct-processor</artifactId>
+                            <version>${mapstruct.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                    <compilerArgs>
+                        <compilerArg>
+                            -Amapstruct.suppressGeneratorTimestamp=true
+                        </compilerArg>
+                        <compilerArg>
+                            -Amapstruct.suppressGeneratorVersionInfoComment=true
+                        </compilerArg>
+                        <compilerArg>
+                            -Amapstruct.defaultComponentModel=spring
+                        </compilerArg>
+                    </compilerArgs>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
-
 </project>

readme.md

@@ -33,8 +33,12 @@ There are actuator health check and info routes as well:
 * [http://localhost:9966/petclinic/actuator/health](http://localhost:9966/petclinic/actuator/health)
 * [http://localhost:9966/petclinic/actuator/info](http://localhost:9966/petclinic/actuator/info)
 
-## Swagger REST API documentation presented here (after application start):
-[http://localhost:9966/petclinic/swagger-ui.html](http://localhost:9966/petclinic/swagger-ui.html)
+## OpenAPI REST API documentation presented here (after application start):
+
+You can reach the swagger UI with this URL
+[http://localhost:9966/petclinic/](http://localhost:9966/petclinic/swagger-ui.html).
+
+You then can get the Open API description reaching this URL [localhost:9966/petclinic/v3/api-docs](localhost:9966/petclinic/v3/api-docs).
 
 ## Screenshot of the Angular client
 

src/main/java/org/springframework/samples/petclinic/mapper/OwnerMapper.java

@@ -0,0 +1,22 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.OwnerDto;
+import org.springframework.samples.petclinic.model.Owner;
+
+import java.util.Collection;
+
+/**
+ * Maps Owner & OwnerDto using Mapstruct
+ */
+@Mapper(uses = PetMapper.class)
+public interface OwnerMapper {
+
+    OwnerDto toOwnerDto(Owner owner);
+
+    Owner toOwner(OwnerDto ownerDto);
+
+    Collection<OwnerDto> toOwnerDtoCollection(Collection<Owner> ownerCollection);
+
+    Collection<Owner> toOwners(Collection<OwnerDto> ownerDtos);
+}

src/main/java/org/springframework/samples/petclinic/mapper/PetMapper.java

@@ -0,0 +1,29 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.PetDto;
+import org.springframework.samples.petclinic.dto.PetTypeDto;
+import org.springframework.samples.petclinic.model.Pet;
+import org.springframework.samples.petclinic.model.PetType;
+
+import java.util.Collection;
+
+/**
+ * Map Pet & PetDto using mapstruct
+ */
+@Mapper
+public interface PetMapper {
+    PetDto toPetDto(Pet pet);
+
+    Collection<PetDto> toPetsDto(Collection<Pet> pets);
+
+    Collection<Pet> toPets(Collection<PetDto> pets);
+
+    Pet toPet(PetDto petDto);
+
+    PetTypeDto toPetTypeDto(PetType petType);
+
+    PetType toPetType(PetTypeDto petTypeDto);
+
+    Collection<PetTypeDto> toPetTypeDtos(Collection<PetType> petTypes);
+}

src/main/java/org/springframework/samples/petclinic/mapper/PetTypeMapper.java

@@ -0,0 +1,20 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.PetTypeDto;
+import org.springframework.samples.petclinic.model.PetType;
+
+import java.util.Collection;
+
+/**
+ * Map PetType & PetTypeDto using mapstruct
+ */
+@Mapper
+public interface PetTypeMapper {
+
+    PetType toPetType(PetTypeDto petTypeDto);
+
+    PetTypeDto toPetTypeDto(PetType petType);
+
+    Collection<PetTypeDto> toPetTypeDtos(Collection<PetType> petTypes);
+}

src/main/java/org/springframework/samples/petclinic/mapper/SpecialtyMapper.java

@@ -0,0 +1,22 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.SpecialtyDto;
+import org.springframework.samples.petclinic.model.Specialty;
+
+import java.util.Collection;
+
+/**
+ * Map Specialty & SpecialtyDto using mapstruct
+ */
+@Mapper
+public interface SpecialtyMapper {
+    Specialty toSpecialty(SpecialtyDto specialtyDto);
+
+    SpecialtyDto toSpecialtyDto(Specialty specialty);
+
+    Collection<SpecialtyDto> toSpecialtyDtos(Collection<Specialty> specialties);
+
+    Collection<Specialty> toSpecialtys(Collection<SpecialtyDto> specialties);
+
+}

src/main/java/org/springframework/samples/petclinic/mapper/UserMapper.java

@@ -0,0 +1,28 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.RoleDto;
+import org.springframework.samples.petclinic.dto.UserDto;
+import org.springframework.samples.petclinic.model.Role;
+import org.springframework.samples.petclinic.model.User;
+
+import java.util.Collection;
+
+/**
+ * Map User/Role & UserDto/RoleDto using mapstruct
+ */
+@Mapper
+public interface UserMapper {
+    Role toRole(RoleDto roleDto);
+
+    RoleDto toRoleDto(Role role);
+
+    Collection<RoleDto> toRoleDtos(Collection<Role> roles);
+
+    User toUser(UserDto userDto);
+
+    UserDto toUserDto(User user);
+
+    Collection<Role> toRoles(Collection<RoleDto> roleDtos);
+
+}

src/main/java/org/springframework/samples/petclinic/mapper/VetMapper.java

@@ -0,0 +1,19 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.VetDto;
+import org.springframework.samples.petclinic.model.Vet;
+
+import java.util.Collection;
+
+/**
+ * Map Vet & VetoDto using mapstruct
+ */
+@Mapper(uses = SpecialtyMapper.class)
+public interface VetMapper {
+    Vet toVet(VetDto vetDto);
+
+    VetDto toVetDto(Vet vet);
+
+    Collection<VetDto> toVetDtos(Collection<Vet> vets);
+}

src/main/java/org/springframework/samples/petclinic/mapper/VisitMapper.java

@@ -0,0 +1,20 @@
+package org.springframework.samples.petclinic.mapper;
+
+import org.mapstruct.Mapper;
+import org.springframework.samples.petclinic.dto.VisitDto;
+import org.springframework.samples.petclinic.model.Visit;
+
+import java.util.Collection;
+
+/**
+ * Map Visit & VisitDto using mapstruct
+ */
+@Mapper(uses = PetMapper.class)
+public interface VisitMapper {
+    Visit toVisit(VisitDto visitDto);
+
+    VisitDto toVisitDto(Visit visit);
+
+    Collection<VisitDto> toVisitsDto(Collection<Visit> visits);
+
+}

src/main/java/org/springframework/samples/petclinic/model/Owner.java

@@ -15,30 +15,15 @@
  */
 package org.springframework.samples.petclinic.model;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
-import javax.persistence.CascadeType;
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.OneToMany;
-import javax.persistence.Table;
-import javax.validation.constraints.Digits;
-import javax.validation.constraints.NotEmpty;
-
 import org.springframework.beans.support.MutableSortDefinition;
 import org.springframework.beans.support.PropertyComparator;
 import org.springframework.core.style.ToStringCreator;
-import org.springframework.samples.petclinic.rest.JacksonCustomOwnerDeserializer;
-import org.springframework.samples.petclinic.rest.JacksonCustomOwnerSerializer;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import javax.persistence.*;
+import javax.validation.constraints.Digits;
+import javax.validation.constraints.NotEmpty;
+import java.util.*;
+
 
 /**
  * Simple JavaBean domain object representing an owner.
@@ -50,8 +35,6 @@
  */
 @Entity
 @Table(name = "owners")
-@JsonSerialize(using = JacksonCustomOwnerSerializer.class)
-@JsonDeserialize(using = JacksonCustomOwnerDeserializer.class)
 public class Owner extends Person {
     @Column(name = "address")
     @NotEmpty
@@ -93,7 +76,7 @@ public String getTelephone() {
     public void setTelephone(String telephone) {
         this.telephone = telephone;
     }
-    @JsonIgnore
+
     protected Set<Pet> getPetsInternal() {
         if (this.pets == null) {
             this.pets = new HashSet<>();
@@ -111,6 +94,10 @@ public List<Pet> getPets() {
         return Collections.unmodifiableList(sortedPets);
     }
 
+    public void setPets(List<Pet> pets) {
+        this.pets = new HashSet<>(pets);
+    }
+
     public void addPet(Pet pet) {
         getPetsInternal().add(pet);
         pet.setOwner(this);