smart-doc is a tool that simultaneously supports the generation of JAVA REST API and Apache Dubbo RPC interface documentation. smart-doc automatically analyzes and generates api interface documentation by utilizing interface generics and javadoc annotations, without any annotation intrusion into the business code. Just introduce the maven or gradle plugin provided by smart-doc in the project, and then generate the api documentation by writing javadoc annotations according to the specifications. At the same time, smart-doc also supports the generation of documents in these specifications such as openapi and postman, and can be directly imported into related tools for testing after generation.

It has been used by well-known companies such as Xiaomi, iFLYTEK, Tongcheng Travel, Kuaishou, Mafengwo, and SF Express in China.

Repository Address

Click

Important Update Contents

• Added support for Jackson framework's JsonFormat
• Fixed the bug of incorrect custom sequence number sorting specified by `@order` for the interface
• Based on the SPI mechanism, opened the parsing extension ability of smart-doc, and supported enterprises to extend the parsing of internal custom Java Web frameworks
• The official documentation of the community was reconstructed based on vitePress

After this version iteration, enterprises can extend smart-doc to complete the parsing of some internal custom web frameworks without modifying the official source code and plugins of smart-doc, and still can ensure that there is no code related to the stable generation framework in the online product.

New Contributors

• @Itswag

Great thanks to the above contributors for their active participation in community contributions.

Acknowledgments

Thanks to @linwumingshi for making a lot of important contributions in this version iteration.

Future Plans

• Add GRPC support (welcome community development and contribution)