jpgough / api-workshop-solution Goto Github PK

The images in the presentation that show the Versioned containers/serverices is large and shows 6 of them. This can be made smaller and would provide more clarity. 4 of these containers would be better

We have the following 2 Todo types:

• https://github.com/jpgough/api-workshop-solution/blob/master/src/main/java/com/jpgough/apiworkshop/domain/Todo.java
  https://github.com/jpgough/api-workshop-solution/blob/master/src/main/java/com/jpgough/apiworkshop/model/Todo.java

My initial thoughts were that model one was to support the controller's POST API to create a new Todo and the domain one to represent our purer domain model, including that Todo's unique ID.

As far as I can tell the domain Todo isn't used however my thoughts are that is should be used to represent the complete Todo object in the domain.

Currently we store a Map of model Todos e.g.

{
   "1" : {
      "description" : "Some todo"
   }
}

However I believe we should store our objects as:

{
   "1" : {
      "id" : "1",
      "description" : "Some todo"
   }
}

An improvement that was mentioned and would streamline the process for attendees is to make the swagger-diff lab more efficent.

At present it required that the CLI Swagger diff tool is available and this includes having Ruby.
What would be better is to have the java lib from http://deepoove.com/swagger-diff/ available and use this to compare swagger specs

A new slide deck should be created that can be used to discuss API Best practacies.

This should have some best practacies from MSFT included. It is important to show that that the key part is to take a standard and follow it. This will give you consistancy

The Version presentation references the API lifecycle from PayPal.
We should include references of MSFT and there standards.