Bayangkan Anda memiliki tim spesialis yang, menurut prinsip kode pertama, membuat sistem dengan banyak kisah bisnis berdasarkan layanan mikro. Semua orang berpengalaman, setiap orang memiliki sesuatu untuk dilakukan selain bagaimana menulis dokumentasi atau spesifikasi untuk API yang dikembangkan. Dan semua orang pada awalnya tahu bahwa jika Anda ingin menggunakan layanan mana, Anda perlu melihat kodenya dan kemudian bertanya dalam obrolan umum jika ada sesuatu yang tidak jelas. Situasi yang akrab bukan? -))) Dan secara umum, semuanya baik-baik saja, jika tim tidak bertambah seiring waktu, jumlah layanan dan fungsi tidak bertambah, bug dari bisnis dan penguji tidak muncul, tidak perlu menyediakan API untuk integrasi ke tim terkait ...
, , . .
. ? , .
- - … . 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 .