java smart-doc文档生成

最新推荐文章于 2024-09-27 00:45:01 发布

糊涂蜗牛

最新推荐文章于 2024-09-27 00:45:01 发布

阅读量291

点赞数 5

文章标签： java 开发语言

本文链接：https://blog.csdn.net/2402_84346849/article/details/142459785

版权

maven 加入插件

  <build>
      <plugin>
        <groupId>com.ly.smart-doc</groupId>
        <artifactId>smart-doc-maven-plugin</artifactId>
        <version>3.0.5</version>
      </plugin>
    </plugins>
  </build>

ant 通过mvn 执行smart-doc

	<target name="docTornaTest">
		<exec executable="mvn.cmd">
			<arg value="-DconfigFile=smart-doc/smart-test.json" />
			<arg value="-DprojectName=临时系统" />
			<arg value="smart-doc:torna-rest" />
		</exec>
	</target>

smart-doc json 配置

{
  "serverUrl": "127.0.0.1:8081",
  "allInOne": true,
  "isStrict": false,
  "coverOld": true,
  "framework": "solon",
  "outPath": "smart-doc/doc",
  "recursionLimit": 7,
  "requestExample": "true",
  "responseExample": "true",
  "openUrl": "http://localhost:7700/api",
  "appToken": "fe5ecfaa177945e6a5d13148b00a0800",
  "debugEnvName": "本地环境",
  "debugEnvUrl": "http://192.168.0.24:8081",
  "tornaDebug": true,
  "replace": true,
  "revisionLogs": [
    {
      "version": "1.0",
      "status": "use",
      "author": "ma",
      "revisionTime": "2024-06-07 17:29:03",
      "remarks": "测试"
    },
    {
      "version": "1.1",
      "status": "use",
      "author": "ma",
      "revisionTime": "2024-06-17 17:29:03",
      "remarks": "测试更新"
    }
  ],
  "errorCodeDictionaries": [
    {
      "title": "title",
      "enumClassName": "com.account.common.ErrorCode",
      "codeField": "code",
      "descField": "msg"
    }
  ],
  "dataDictionaries": [
    {
      "title": "PlatFormType",
      "enumClassName": "com.account.common.PlatformType",
      "codeField": "id",
      "descField": "name"
    }
  ],
  "customResponseFields": [
    {
      "name": "name",
      "desc": "desc",
      "ownerClassName": "com.newticee.sys.account.common.Result",
      "value": "value"
    }
  ],
  "packageFilters": "com.account.controller.StartController.start*",
  "requestHeaders": [
		{
			"name": "authorization",
			"type": "string",
			"desc": "系统使用",
			"required": true,
			"since": "1.0",
			"excludePathPatterns": "/user/loginAccount,/user/vipList,/out/**,/start/**"
		}
	]
}