想象一下，您有一个专家团队，他们按照代码优先原则，构建了一个基于微服务的具有许多业务案例的系统。所有人都是有经验的人，除了如何为已开发的API编写文档或规范外，每个人都有所要做的事情。每个人最初都知道，如果您想使用哪种服务，则需要查看代码，然后在常规聊天中询问是否不清楚。是不是很熟悉？ -）））总的来说，一切都很好，如果团队没有随着时间的推移而增长，服务和功能的数量没有增长，业务和测试人员的错误也没有出现，那么就不需要为集成到相关团队提供API。
在撰写本文时，这篇文章是我个人的观点，即在没有微服务的情况下用于记录微服务的最小结构。个人意见是在集思广益的实际情况并在开发中型业务应用程序时寻求质量改进的过程中产生的。
所以。入口处有什么？在入口处，我们有一个开发过程，看起来非常快速且最佳。
- 在流程的输入中，有一些业务案例按类型描述了业务活动和案例级别上的功能需求。我喜欢A想要得到B。可以这么说，这是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 .