Standard Operating Procedure

sop-ms-2.0.0

Microservice

Microservice diagram

The standard for the microservice reflects an onion design - layers of layers, where many of the layers are reflected in catogorisation of logic by folder.

The bin directory is expected to contain any executable scripts related to the service, helpers or production scrips - all the same.

The doc folder is where we store both the documetation of dependencies to the microservice, as well as the documentation of the developed microservice/solution.

The src folder contains the source code of the project, this is where all the logic should be found. The source folder is expected to be composed by a set of sub layers:

Client - the client side code used by other solutions to be able to depend on the service while following DRY principles in the context of the complete stack.
Schema - the data structures that describes all DTO’s - data transfer objects.
Server - the logic that will run on the server.
Test - the test suit or specs should be aggregated in one place to improve transparency for anyone who want’s to read and understand how to interact with the code.

Apart from this folder structure, a .gitignore file is expected to be provided to help keep things clean, a Dockerfile is present to explain the service environment, and to provide the insight necessery on how to deploy the service, and finally a README file to document the pupose of the service, and any navigational insight to where one can learn more about the service.