Et si personne ne veut documenter? Organiser au minimum la documentation des microservices - partie 2

Cet article est une suite. Voir la première partie ici

Approche de mise en œuvre

Fichier Readme.md

Des informations générales sur le fichier Readme.md sont présentées ici - https://www.makeareadme.com/ .

La version réelle du fichier doit se trouver sur la branche par défaut.

Le fichier doit avoir la structure suivante:

• Nom du composant
• Statut et propriétaire du composant (microservice)
• .
• .
• ,

Readme.md — ()

, . , .

:

• CREATED — , . . .
• DEV — . , , . DEV . DEV . , , Readme.md .
• PROD- . . PROD . , , Readme.md . , EOL.
• EOL — . .
• ARCHIVE- ( ) , .

Readme.md —

, , , .

Readme.md —

, « ?» « ?». , , .

, 30-50 , , .

, , — . - - , . , .

Readme.md —

, . ( ) ( ).

, Readme.md .

Readme.md — ,

, , . — .

. , java-doc.

Confluence .

, , , Readme.

, .

, , , .

Readme.md —

, , ().

. — ​​, , , .

-, . , , .

« » — https://en.wikipedia.org/wiki/Hexagonal_architecture_(software).

:

• inbound — .
  
  — — , -. .
  
  — dto — dto,
  
  — — : rest, Kafka, MQ . ,
• outbound- . , , .
  
  — service — , -
  
  — dto —
  
  — : rest, Kafka, MQ .
• domain — , .
  
  — — JPA . , , NoSQL, , CRUD
• bussines — -, - . — -

( ) «inbound», «outbound» «domain» . - .

, , , , -).

Swagger REST

REST — . REST , .

Swagger :

• , .
• ,

Jira

, .

, Jira :

— Jira-issue, issue , . , , Component Object Jira. , , .

, — (, Confluence) .

Confluence , , , Confluence.

Swagger-HUB

Swagger-HUB . , build-pipeline, , .

. , , , , . , , , - , , .

, . « », .

: , . SwaggerHub , API.

, . - . . , ( Readme.md) Jira.

!!!