Improved swagger documentation.

Author: dartartem

ftgo-accounting-service/src/main/java/net/chrisrichardson/ftgo/accountingservice/main/AccountingServiceMain.java

@@ -3,6 +3,7 @@
 import io.eventuate.local.java.spring.javaclient.driver.EventuateDriverConfiguration;
 import io.eventuate.tram.spring.commands.producer.TramCommandProducerConfiguration;
 import io.eventuate.tram.spring.jdbckafka.TramJdbcKafkaConfiguration;
+import net.chrisrichardson.eventstore.examples.customersandorders.commonswagger.CommonSwaggerConfiguration;
 import net.chrisrichardson.ftgo.accountingservice.messaging.AccountingMessagingConfiguration;
 import net.chrisrichardson.ftgo.accountingservice.web.AccountingWebConfiguration;
 import org.springframework.boot.SpringApplication;
@@ -15,7 +16,8 @@
 @Import({AccountingMessagingConfiguration.class, AccountingWebConfiguration.class,
         TramCommandProducerConfiguration.class,
         EventuateDriverConfiguration.class,
-        TramJdbcKafkaConfiguration.class})
+        TramJdbcKafkaConfiguration.class,
+        CommonSwaggerConfiguration.class})
 public class AccountingServiceMain {
 
   public static void main(String[] args) {

ftgo-common/src/main/java/net/chrisrichardson/ftgo/common/DeliveryActionType.java

@@ -0,0 +1,4 @@
+package net.chrisrichardson.ftgo.common;
+
+public enum DeliveryActionType { PICKUP, DROPOFF
+}

ftgo-delivery-service/src/main/java/net/chrisrichardson/ftgo/deliveryservice/domain/DeliveryState.java renamed to ftgo-common/src/main/java/net/chrisrichardson/ftgo/common/DeliveryState.java

@@ -1,4 +1,4 @@
-package net.chrisrichardson.ftgo.deliveryservice.domain;
+package net.chrisrichardson.ftgo.common;
 
 public enum DeliveryState {
   CANCELLED, SCHEDULED, PENDING

ftgo-delivery-service-api/build.gradle

@@ -0,0 +1,3 @@
+dependencies {
+    compile project(":ftgo-common")
+}

ftgo-delivery-service-api/src/main/java/net/chrisrichardson/ftgo/deliveryservice/api/web/ActionInfo.java

@@ -1,20 +1,22 @@
 package net.chrisrichardson.ftgo.deliveryservice.api.web;
 
+import net.chrisrichardson.ftgo.common.DeliveryActionType;
+
 public class ActionInfo {
-  private String type;
+  private DeliveryActionType type;
 
   public ActionInfo() {
   }
 
-  public ActionInfo(String type) {
+  public ActionInfo(DeliveryActionType type) {
     this.type = type;
   }
 
-  public String getType() {
+  public DeliveryActionType getType() {
     return type;
   }
 
-  public void setType(String type) {
+  public void setType(DeliveryActionType type) {
     this.type = type;
   }
 }

ftgo-delivery-service-api/src/main/java/net/chrisrichardson/ftgo/deliveryservice/api/web/DeliveryInfo.java

@@ -1,14 +1,16 @@
 package net.chrisrichardson.ftgo.deliveryservice.api.web;
 
+import net.chrisrichardson.ftgo.common.DeliveryState;
+
 public class DeliveryInfo {
 
   private long id;
-  private String state;
+  private DeliveryState state;
 
   public DeliveryInfo() {
   }
 
-  public DeliveryInfo(long id, String state) {
+  public DeliveryInfo(long id, DeliveryState state) {
 
     this.id = id;
     this.state = state;
@@ -22,11 +24,11 @@ public void setId(long id) {
     this.id = id;
   }
 
-  public String getState() {
+  public DeliveryState getState() {
     return state;
   }
 
-  public void setState(String state) {
+  public void setState(DeliveryState state) {
     this.state = state;
   }
 }

ftgo-delivery-service/src/main/java/net/chrisrichardson/ftgo/deliveryservice/domain/Action.java

@@ -1,18 +1,18 @@
 package net.chrisrichardson.ftgo.deliveryservice.domain;
 
+import net.chrisrichardson.ftgo.common.DeliveryActionType;
 import net.chrisrichardson.ftgo.common.Address;
 
 import javax.persistence.Embeddable;
 import javax.persistence.EnumType;
 import javax.persistence.Enumerated;
-import javax.persistence.ManyToOne;
 import java.time.LocalDateTime;
 
 @Embeddable
 public class Action {
 
   @Enumerated(EnumType.STRING)
-  private ActionType type;
+  private DeliveryActionType type;
   private Address address;
   private LocalDateTime time;
 
@@ -21,7 +21,7 @@ public class Action {
   private Action() {
   }
 
-  public Action(ActionType type, long deliveryId, Address address, LocalDateTime time) {
+  public Action(DeliveryActionType type, long deliveryId, Address address, LocalDateTime time) {
     this.type = type;
     this.deliveryId = deliveryId;
     this.address = address;
@@ -33,15 +33,15 @@ public boolean actionFor(long deliveryId) {
   }
 
   public static Action makePickup(long deliveryId, Address pickupAddress, LocalDateTime pickupTime) {
-    return new Action(ActionType.PICKUP, deliveryId, pickupAddress, pickupTime);
+    return new Action(DeliveryActionType.PICKUP, deliveryId, pickupAddress, pickupTime);
   }
 
   public static Action makeDropoff(long deliveryId, Address deliveryAddress, LocalDateTime deliveryTime) {
-    return new Action(ActionType.DROPOFF, deliveryId, deliveryAddress, deliveryTime);
+    return new Action(DeliveryActionType.DROPOFF, deliveryId, deliveryAddress, deliveryTime);
   }
 
 
-  public ActionType getType() {
+  public DeliveryActionType getType() {
     return type;
   }
 

ftgo-delivery-service/src/main/java/net/chrisrichardson/ftgo/deliveryservice/domain/ActionType.java

@@ -1,6 +1,7 @@
 package net.chrisrichardson.ftgo.deliveryservice.domain;
 
 import net.chrisrichardson.ftgo.common.Address;
+import net.chrisrichardson.ftgo.common.DeliveryState;
 
 import javax.persistence.*;
 import java.time.LocalDateTime;

ftgo-delivery-service/src/main/java/net/chrisrichardson/ftgo/deliveryservice/domain/Delivery.java

@@ -113,10 +113,10 @@ private DeliveryStatus makeDeliveryStatus(Delivery delivery, Long assignedCourie
   }
 
   private DeliveryInfo makeDeliveryInfo(Delivery delivery) {
-    return new DeliveryInfo(delivery.getId(), delivery.getState().name());
+    return new DeliveryInfo(delivery.getId(), delivery.getState());
   }
 
   private ActionInfo makeActionInfo(Action action) {
-    return new ActionInfo(action.getType().name());
+    return new ActionInfo(action.getType());
   }
 }