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

希望最外层能加一层包名 #7

Closed
wangpeng2020 opened this issue Oct 23, 2019 · 24 comments
Closed

希望最外层能加一层包名 #7

wangpeng2020 opened this issue Oct 23, 2019 · 24 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@wangpeng2020
Copy link
Contributor

当前文档是按controller来展示的,我有好多个包,这样都展示在同一级的话不好区分具体是哪个包的了。

@liuhuagui
Copy link
Owner

您是希望在ui界面的导航添加吗?

@wangpeng2020
Copy link
Contributor Author

是的,UI上能将不同包的有个区分就行了。我想的是可以左边再加一级目录,最外层展示的是包名,然后下面两级分别是controller和接口方法。 不知还有什么好的方式。

@liuhuagui
Copy link
Owner

前端工程师对包名能不能很好的理解,可能你需要的是package-info,即功能分类

@wangpeng2020
Copy link
Contributor Author

不是,就是比如配置里面加了两个包
packages:

  • a.b.c
  • a.b.d
    那能否在前端界面上把这两个加进去,菜单变成
    a.b.c(一级菜单)
    -- cContorller(二级菜单)
    --cmethod(三级菜单)
    a.b.d(一级菜单)
    -- dContorller(二级菜单)
    --dmethod (三级菜单)
    或者用其他方法也行,就是希望能将不同的包扫描出来的接口可以区分开发。

@liuhuagui
Copy link
Owner

您好,我只是不明白,这样对于前端阅读上有什么好处吗,他们可能更容易理解功能分类,而不是包吧

@wangpeng2020
Copy link
Contributor Author

这个可能和我的用法有点关系。
如果是开发, 一般用法就是把这个依赖放到自己工程里,这样每个服务有自己文档地址,看到的也只是这个服务的接口,这种情况加这不加这个没有太大的关系。
但作为测试人员,我只要需要在一个springdemosample里加上这个依赖,就可以扫描所有项目源码,获取到所有微服务的接口,这样我能在一个页面看到所有微服务的接口,但代价只是获取到所有微服务的源码。但我们的微服务数量有40+,整理的接口数量会比较多。如果不已包名或其他方式做分类的话,将很难区分这个接口是属于哪个微服务的。

@liuhuagui
Copy link
Owner

Ok,明白了。期待新版本吧ღ💌ღ

@liuhuagui
Copy link
Owner

多谢支持

@wangpeng2020
Copy link
Contributor Author

好的,这个项目挺好,我也是觉得Swagger那种方式捆绑代码太厉害,而使用这种标准restful注释,开发会更容易接受,轻量级,也没有什么成本,强烈支持! 希望这个项目越来越好。

@liuhuagui
Copy link
Owner

请问贵公司是?还在使用Smalldoc吗,预计这周之前包区分会上线

@wangpeng2020
Copy link
Contributor Author

wangpeng2020 commented Dec 24, 2019 via email

@liuhuagui
Copy link
Owner

请问贵公司是?

@oneCrossOver
Copy link

macos 配置项目的绝对路径 无效~

@liuhuagui
Copy link
Owner

给出路径配置还有JDK版本

@oneCrossOver
Copy link

-sourcepath is /Users/zhangbo/IdeaProjects/snow/snow-common/src/main/java;/Users/zhangbo/IdeaProjects/snow/snow-admin/src/main/java;

jdk:1.8.0_201

@liuhuagui
Copy link
Owner

报错了吗?

@oneCrossOver
Copy link

没有报错,扫描不到接口

@oneCrossOver
Copy link

没有接口目录

@liuhuagui
Copy link
Owner

等我去弄一台Mac测试一下,

@liuhuagui
Copy link
Owner

估计要过些日子

@oneCrossOver
Copy link

我试了下,windows 可以 展示~。

@liuhuagui
Copy link
Owner

还未走过MacOS的测试

@liuhuagui
Copy link
Owner

估计是写了不兼容的代码

@liuhuagui
Copy link
Owner

@wangpeng2020 @oneCrossOver smalldoc-2.4 发布,你们想要的都在里面,让你们久等了!!https://github.com/liuhuagui/smalldoc/releases/tag/2.4

@liuhuagui liuhuagui added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Apr 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 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

3 participants