Stellen Sie sich vor, Sie haben ein Team von Spezialisten, die nach dem Code-First-Prinzip ein System mit vielen Geschäftsgeschichten erstellen, die auf Microservices basieren. Alle Menschen sind erfahren, jeder hat etwas zu tun, außer wie man Dokumentation oder Spezifikationen für die entwickelte API schreibt. Und jeder weiß zunächst, dass Sie, wenn Sie welchen Dienst nutzen möchten, in den Code schauen und dann im allgemeinen Chat fragen müssen, ob etwas nicht klar ist. Eine vertraute Situation, nicht wahr? -))) Und im Allgemeinen ist alles in Ordnung, wenn das Team im Laufe der Zeit nicht gewachsen ist, die Anzahl der Dienste und Funktionen nicht gewachsen ist, Fehler von Unternehmen und Testern nicht aufgetreten sind und keine API für die Integration in verwandte Teams bereitgestellt werden musste ...
, , . .
. ? , .
- - … . 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 .