コードファーストの原則に従って、マイクロサービスに基づいて多くのビジネスストーリーを備えたシステムを作成するスペシャリストのチームがあると想像してください。すべての人が経験を積んでおり、開発されたAPIのドキュメントや仕様を作成する方法以外に、誰もが何かすることがあります。そして、どのサービスを使用したいのかを最初に知っているのは、コードを調べてから、一般的なチャットで何かが明確でないかどうかを尋ねる必要があるということです。おなじみの状況ですね。 -）））そして、一般的に、すべてが順調です。チームが時間の経過とともに成長しなかった場合、サービスと機能の数が増加しなかった場合、企業やテスターからのバグが発生しなかった場合、関連するチームに統合するためのAPIを提供する必要はありませんでした...
, , . .
. ? , .
- - … . 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 .