smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具,Torna 是由 smart-doc 官方独家推动联合研发的企业级文档管理系统,smart-doc-maven-plugin 是 smart-doc 官方团队开发的maven插件。
| 名称 | 版本 |
|---|---|
| smart-doc-maven-plugin | 2.4.7 |
| torna | 1.15.1 |
smart-doc.json 配置,含统一请求、返回处理:
{
"serverUrl": "http://127.0.0.1",
"isStrict": false,
"outPath": "",
"packageFilters": "",
"projectName": "smart-doc",
"appToken": "*****************",
"openUrl": "http://127.0.0.1:7700/api",
"debugEnvName":"测试环境",
"replace": true,
"debugEnvUrl":"http://127.0.0.1",
"language": "CHINESE",
"responseBodyAdvice": {
"className": "com.test.util.Result"
},
"requestHeaders": [{
"name": "token",
"type": "string",
"desc": "desc",
"required": true,
"since": "-"
}]
}
效果:

版权声明:本文为ChinaLiaoTian原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。