@ApiGroup详解 - smalldragoncai/ApiAnnotations GitHub Wiki

@ApiGroup详解

此注解使用在类上,说明这个类会自动生成相关java类文件。 此类定义一个Method将生成一个HttpServlet文件。 前提:需要声明javadoc,必要时javadoc需包含某些标记,如下

Type javadoc标记有

1. @id 组Id 必填 限制Method的Id需以此id开头
2. @description 组描述 必填 阅读代码需要
3. @author 开发者 必填 阅读代码需要

Method javadoc标记有

1. 首行描述 接口描述 必填 阅读代码需要
2. @id 接口Id 必填 http访问需要(如:http://localhost:8080/{id})
3. @descriptions 方法参数描述,每个参数都需要描述,以/隔开;以(*)开头,表示参数必填 必填 1.阅读代码需要 2.以(*)开头则生成的代码会做非空判断
4. @path 访问的路径,支持Rest 选填 提供额外http访问路径,[Rest格式案例](http://baidu.com)

⚠️ **GitHub.com Fallback** ⚠️