Imaginez que vous ayez une équipe de spécialistes qui, selon le principe du code d'abord, créent un système avec de nombreuses histoires commerciales basées sur des microservices. Tout le monde est expérimenté, tout le monde a quelque chose à faire en plus d'écrire la documentation ou les spécifications de l'API développée. Et tout le monde sait au départ que si vous voulez utiliser quel service, vous devez examiner le code, puis demander dans le chat général si quelque chose n'est pas clair. Une situation familière n'est-ce pas? -))) Et en général, tout va bien si l'équipe n'a pas grandi avec le temps, le nombre de services et de fonctions n'a pas augmenté, les bugs des entreprises et des testeurs n'apparaissaient pas, il n'était pas nécessaire de fournir une API pour l'intégration aux équipes liées ...
, , . .
. ? , .
- - … . 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 .