记一次smalldoc解决issue的过程,希望smalldoc帮助更多的java开发者

345 阅读3分钟

issue#8

jiyuren

建议添加一个可以运行的springboot demo,目前集成路径访问不到,资源文件映射都不知道怎么写了

liuhuagui

多模块项目?

jiyuren

多模块项目?
是的,加上shiro需要手动添加资源映射,没有运行起来,不知道能不能把jar中的实体类的字段给解析出来

liuhuagui

smalldoc:
  source-paths: #额外的源码路径(项目的源码路径默认已经包含在内,不需要再添加)
    - 'D:\Workspaces\myBeanProject\my-bean\src\main\java'
    - 'D:\Maven\Repositories\repository\com\aliyun\aliyun-java-sdk-core\3.5.0'

尝试一下

jiyuren

smalldoc:
  source-paths: #额外的源码路径(项目的源码路径默认已经包含在内,不需要再添加)
    - 'D:\Workspaces\myBeanProject\my-bean\src\main\java'
    - 'D:\Maven\Repositories\repository\com\aliyun\aliyun-java-sdk-core\3.5.0'

尝试一下

目前是项目运行我访问不到路径,新建一个普通的没有过多配置的项目,我也访问不到index.html啊

liuhuagui

报错没有? 可以展示你的配置和访问路径吗

jiyuren

报错没有? 可以展示你的配置和访问路径吗

`server:
port: 8090

logging.level.org.springframework.boot.autoconfigure: ERROR

logging:
config: classpath:log4j2-test.xml

smalldoc:
source-paths: #额外的源码路径(项目的源码路径默认已经包含在内,不需要再添加)
- 'D:\workspace\jinmi\java\testjar\test-web\src\main\java'
packages:
- qcom.jiyuren.web.controller
project-name: 我的文档
enabled: true #默认为true
url-pattern: /smalldoc/* #默认为/smalldoc/*`
http://127.0.0.1:8090/smalldoc

liuhuagui

spring: 
  profiles:
    active: dev

接口文档默认是在dev环境中使用的

jiyuren

spring: 
  profiles:
    active: dev

接口文档默认是在dev环境中使用的

配置了一下,果然可以运行了,但是建议取消这个dev环境配置,因为多环境配置中加入有自定义的环境呢,这样就需要生成静态html直接预览了,但是实体类映射字段,都需要手动@{fn1,fn2,...}才能显示出请求参数

liuhuagui

spring: 
  profiles:
    active: dev,prod,test,custom #支持多配置,逗号隔开即可

@{fn1,fn2,...} 的使用是为了解决参数字段 required 问题 —— 尽管是同一个实体类,但是不同接口需要的字段参数不尽相同,不过放心,对于返回参数,所有字段都会显示出来。

jiyuren

spring: 
  profiles:
    active: dev,prod,test,custom #支持多配置,逗号隔开即可

@{fn1,fn2,...} 的使用是为了解决参数字段 required 问题 —— 尽管是同一个实体类,但是不同接口需要的字段参数不尽相同,不过放心,对于返回参数,所有字段都会显示出来。

那再加一个@{*} 设置都显示参数怎么样呢

liuhuagui

诶,想法不错,好的,期待下个版本吧,多谢支持

jiyuren

诶,想法不错,好的,期待下个版本吧,多谢支持

感谢你这个项目啊,对比了不少根据注释生成文档的项目,发现都有各自的问题,有的jar包中的实体类字段映射不出来,有xDoc,JApiDocs,Easy-doc-core,httpdoc,smart-doc,都不太完美啊,需要完善

liuhuagui

感谢支持