Cloud Native Development Patterns and Best Practices

Example – asynchronous API documentation

The following is an example of documenting the event types that have been used throughout the examples in this chapter. TypeScript interfaces are a concise way to document the structure of JSON payloads. These can be leveraged in the code itself when using Node.JS to implement components, but they are useful on their own, regardless of the implementation language. Notice that the ItemChangeEvent format includes both the old and new image of the data. This information is usually provided by a cloud-native database's change data capture feature. Both images are included, in the spirit of including all available context information, so that consumers can calculate deltas if need be.

// Event Envelope ...