【D3S】REST接口文档自动生成 - 集成smart-doc并同步配置到Torna

一、引言

D3S（DDD with SpringBoot）为本作者使用DDD过程中开发的框架，目前已可公开查看源码，笔者正在持续完善该框架，争取打造一个可落地的DDD框架。而在开发D3S框架的过程中，相较Swagger、OpenApi以注解侵入代码的方式，笔者选择了smart-doc以代码注释的形式来完成REST接口文档的生成，配合Torna可以方便完成接口文档同步与管理的工作。之前笔者也成使用过YAPI，但是目前YAPI对OpenApi 3.0支持的不是很好，实测将OAS 3.0的接口文档JSON导入YAPI后，会出现接口返回结果为空的情况，实测Torna对OAS 3.0支持的较为完善，同时Torna也支持直接导入Swagger/OAS文档（JSON/YAML）或URL链接导入，故现阶段如果想选择一款文档管理工具，还是比较推荐Torna。