TongchengOpenSource / smart-doc

Smart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-injection.
https://smart-doc-group.github.io/#/
Apache License 2.0
1.41k stars 276 forks source link

For the development of other framework document parsing, can this functionality be added through plugin dependency instead of modifying the source code? #592

Open kongwu- opened 1 year ago

kongwu- commented 1 year ago

Summary

For the development of other framework document parsing, this functionality can be added through plugin dependency instead of modifying the source code.

Modifying the source code is, after all, a bit too aggressive; once you change the source code for secondary development, you can no longer follow the updates of Smart-Doc, turning it into a one-time version.

Possible implementation ideas:

其他框架文档解析开发,这个功能是否可以通过添加plugin dependency形式,而不是修改源码。

修改源码毕竟还是太粗暴了,一旦改源码二次开发,基本无法再跟随smart-doc的更新,成了一次性的版本。

可能的实现思路:

shalousun commented 1 year ago

@kongwu- This will have to wait for a while, as Smart-Doc is currently preparing for some future community development projects. After preparations are complete, there will be some community weekly meetings and such, where you can participate in discussions. The main issue with other frameworks is that we lack understanding of the custom framework patterns used by many companies. 这个要等一段时间,smart-doc最近在筹备一些未来社区建设上的事情。后面筹备好会有一些社区的周会这些,可以参加讨论。对于其它框架这块的主要还是我们缺乏对很多公司自定义框架形态的了解。

linwumingshi commented 1 month ago

@kongwu- upgrade to 3.0.6+

Other Framework Documentation Parsing Development (Based on JAVA SPI)