Skip to main content
deleted 2 characters in body
Source Link
Dherik
  • 2.5k
  • 23
  • 34

I think the besta good idea is create a diagram of integrations and include this in your repository. Choose some free tool (like draw.io) that can export the diagram in a XML or JSON file and commit this file in your repository. If you use Github or Gitlab, generate the image from this diagram and include in the Wiki or even in the README.md file, so the image will be visible every time the developer visualize the repository from the browser.

The same strategy can be used for the database.

About the API resource documentation, Swagger is a good option.

This problem becomes amplified when you have many services that are interdependent on each other. Perhaps at that point you doing microservices wrong, but I digress.

This is a problem, for sure.

I think the best idea is create a diagram of integrations and include this in your repository. Choose some free tool (like draw.io) that can export the diagram in a XML or JSON file and commit this file in your repository. If you use Github or Gitlab, generate the image from this diagram and include in the Wiki or even in the README.md file, so the image will be visible every time the developer visualize the repository from the browser.

The same strategy can be used for the database.

About the API resource documentation, Swagger is a good option.

This problem becomes amplified when you have many services that are interdependent on each other. Perhaps at that point you doing microservices wrong, but I digress.

This is a problem, for sure.

I think a good idea is create a diagram of integrations and include this in your repository. Choose some free tool (like draw.io) that can export the diagram in a XML or JSON file and commit this file in your repository. If you use Github or Gitlab, generate the image from this diagram and include in the Wiki or even in the README.md file, so the image will be visible every time the developer visualize the repository from the browser.

The same strategy can be used for the database.

About the API resource documentation, Swagger is a good option.

This problem becomes amplified when you have many services that are interdependent on each other. Perhaps at that point you doing microservices wrong, but I digress.

This is a problem, for sure.

Source Link
Dherik
  • 2.5k
  • 23
  • 34

I think the best idea is create a diagram of integrations and include this in your repository. Choose some free tool (like draw.io) that can export the diagram in a XML or JSON file and commit this file in your repository. If you use Github or Gitlab, generate the image from this diagram and include in the Wiki or even in the README.md file, so the image will be visible every time the developer visualize the repository from the browser.

The same strategy can be used for the database.

About the API resource documentation, Swagger is a good option.

This problem becomes amplified when you have many services that are interdependent on each other. Perhaps at that point you doing microservices wrong, but I digress.

This is a problem, for sure.