Este artículo es una continuación. Mira la primera parte aquí
Estrategia de implementación
Archivo Readme.md
La información general sobre el archivo Readme.md se presenta aquí: https://www.makeareadme.com/ .
La versión real del archivo debe estar en la rama predeterminada.
El archivo debe tener la siguiente estructura:
- Nombre del componente
- Estado y propietario del componente (microservicio)
- .
- .
- ,
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.
!!!