dubbo自动生成接口文档

dubbo自动生成接口文档

1、介绍

    本文介绍如何利用smart-doc自动生成dubbo接口文档，以及相关的代码配置；

2、代码

2.1、dubbo接口扫描

smart-doc支持单独去扫描dubbo api或者dubbo provider。在扫描原理是主要通过识别@dubbo注释tag(idea可以支持添加自定义注释tag提示可以参考smart-doc wiki文档介绍)或dubbo的 @service注解。

2.2、扫描dubbo api

dubbo api通常都是很简洁的dubbo接口定义，如果你需要让smart-doc扫描到dubbo接口，那么需要加上@dubbo注释tag。示例如下：
样例

2.3、扫描dubbo provider

如果想通过dubbo provider生成rpc接口文档的情况，你不需要加任何的其他注释tag，smart-doc自动扫描@service注解完成。
样例

3、配置文件

3.1、maven配置增加smart-doc-maven-plugin

<plugin>
 <groupId>com.github.shalousun</groupId>
 <artifactId>smart-doc-maven-plugin</artifactId>
 <version>2.1.7</version>