Imagine que tiene un equipo de especialistas que, de acuerdo con el principio de código primero, crean un sistema con muchas historias comerciales basado en microservicios. Todas las personas tienen experiencia, todos tienen algo que hacer además de cómo escribir documentación o especificaciones para la API desarrollada. Y todo el mundo sabe inicialmente que si desea utilizar qué servicio, debe buscar en el código y luego preguntar en el chat general si algo no está claro. Una situación familiar, ¿no? -))) Y en general, todo está bien, si el equipo no creció con el tiempo, la cantidad de servicios y funciones no creció, no aparecieron bugs de empresas y testers, no se requería brindar una API para la integración a equipos relacionados ...
, , . .
. ? , .
- - … . Confluence.
- - Jira .
- , . .
- , , - — Jira
? . . :
- - ( Jira)
- ( , REST json DTO, .
- , REST .
, contract-first , . , , .
TO-DO . . , . . — .
- « »
- ,
- "Single source of true"
:
- Readme.md — , .
- REST Swagger. Swagger Hub
- ,
- Jira , . Jira — Component
- , Readme.md
. . .
Gitlab
Readme.md
Readme.md — . « ». ( ) :
- ?
- ?
- ? ?
- ?
- ?
- ? ? ?
- ?
Readme .md , . , « », .
Swagger REST
Swagger REST REST . Swagger Hub REST. , , , API .
Swagger . . REST , , .
, /src. .
, /doc, . , AsciiDoc (https://asciidoc.org/) PlanUML (https://plantuml.com/).
DAO, JPA REST. .
Jira
Jira — , . Jira , . , .
Jira , , Jira , , ( ) .
"" Jira Jira . . , , .
Jira :
- — . , , . .
- —
- ( ) — , , . ,
Confluence
Service Report ( ) — . — , Readme.md.
Gitlab, Readme.md. , , Gitlab
Swagger Hub
Swagger Hub REST Swagger .