Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

建议添加一个可以运行的demo #8

Closed
jiyuren opened this issue Nov 7, 2019 · 13 comments
Closed

建议添加一个可以运行的demo #8

jiyuren opened this issue Nov 7, 2019 · 13 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@jiyuren
Copy link

jiyuren commented Nov 7, 2019

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

@liuhuagui
Copy link
Owner

多模块项目?

@jiyuren
Copy link
Author

jiyuren commented Nov 8, 2019

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

@liuhuagui
Copy link
Owner

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
Copy link
Author

jiyuren commented Nov 8, 2019

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
Copy link
Owner

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

@jiyuren
Copy link
Author

jiyuren commented Nov 8, 2019

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

`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
Copy link
Owner

spring: 
  profiles:
    active: dev

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

@jiyuren
Copy link
Author

jiyuren commented Nov 8, 2019

spring: 
  profiles:
    active: dev

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

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

@liuhuagui
Copy link
Owner

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

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

@jiyuren
Copy link
Author

jiyuren commented Nov 8, 2019

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

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

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

@liuhuagui
Copy link
Owner

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

@jiyuren
Copy link
Author

jiyuren commented Nov 8, 2019

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

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

@liuhuagui
Copy link
Owner

感谢支持

@jiyuren jiyuren closed this as completed Nov 8, 2019
@liuhuagui liuhuagui added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers and removed documentation Improvements or additions to documentation labels Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants