@RestController
@RequestMapping("/order")
@Doc("小程序用户端订单相关") //注解在类上，表示接口分组，不同的类可以用相同的名称来合并接口
@Validated
public interface OrderService {

    @Doc("下单接口") //注解在方法上，表示接口名称
    @PostMapping(value = "/create")
    OrderVo createOrder(OrderDto dto);//接口会自动解释OrderDto类的成员属性为参数

    @Doc(value = "取消订单接口", scope = false) //注解在方法上，表示接口名称 scope=false表示不解释方法中的参数，而直接采用方法上的Doc注解所写的为接口参数
    @Doc(name = "orderId", value = "订单id", required = true)
    @PostMapping(value = "/cancel")
    Boolean cancelOrder(@NotNull(message = "2010000=订单id不能为空") Long orderId);

    @Doc("更换销售接口")
    @Doc(name = "orderId", value = "订单id", required = true) //作为方法中参数的补充 name要于方法中参数名相同
    @Doc(name = "sellerId", value = "销售顾问id", required = true) //作为方法中参数的补充 name要于方法中参数名相同
    @PostMapping(value = "/seller/change/{orderId}")
    @ReturnDoc("true:更换成功 false:更换失败") //对于返回基本类型数据(及其包装类型)的方法作额外补充
    Boolean changeSeller(@PathVariable Long orderId, @NotNull(message = "2010007=销售顾问id不能为空") Long sellerId);

    @Doc("查询订单列表接口")
    @GetMapping(value = "/list/get")
    @ParameterFilter(excludes={"page"}, requires={"size"}) //该注解可以设置必传参数，忽略参数，仅包含的参数 此处是排除PageDto中属性page作为参数，并把属性size设置成必传
    List<OrderListVo> getOrderList(PageDto dto);

    @Doc("查询订单详情接口")
    @GetMapping(value = "/detail/{orderId}")
    @Doc(name = "orderId", value = "订单id", required = true)
    @ReturnFilter(excludes={"creatorId"}) //过滤响应数据OrderDetailVo中的creatorId属性 该注解通常是用来过滤敏感数据
    OrderDetailVo getOrderDetail(@PathVariable Long orderId);

}

public class Address implements Serializable {
    
    private static final long serialVersionUID = 78060976917708800L;

    /**
     * 
     * 对应表字段core_address.id
     */
    @Doc(value="", remark="")
    private Long id;

    /**
     * 地点名称
     * 对应表字段core_address.name
     */
    @Doc(value="地点名称", remark="")
    private String name;

    /**
     * 路径代码 暂定备用
     * 对应表字段core_address.path_code
     */
    @Doc(value="路径代码", remark="暂定备用")
    private String pathCode;

    /**
     * 顶级编号
     * 对应表字段core_address.super_id
     */
    @Doc(value="顶级编号", remark="")
    private Long superId;

    /**
     * 上级地点编号
     * 对应表字段core_address.parent_id
     */
    @Doc(value="上级地点编号", remark="")
    private Long parentId;

    /**
     * 详细地址
     * 对应表字段core_address.address
     */
    @Doc(value="详细地址", remark="")
    private String address;

    /**
     * 所有上级编号 逗号隔开
     * 对应表字段core_address.parent_arr
     */
    @Doc(value="所有上级编号", remark="逗号隔开")
    private String parentArr;

    /**
     * 所有上级名称 >号隔开
     * 对应表字段core_address.parent_name_arr
     */
    @Doc(value="所有上级名称", remark=">号隔开")
    private String parentNameArr;

    /**
     * 所有下级编号 逗号隔开 第一个为本级
     * 对应表字段core_address.child_arr
     */
    @Doc(value="所有下级编号", remark="逗号隔开 第一个为本级")
    private String childArr;

    /**
     * 备注
     * 对应表字段core_address.remark
     */
    @Doc(value="备注", remark="")
    private String remark;

    /**
     * 类型 地点所属类型比如1小区、2分区、3楼宇、4单元、5附属之类的
     * 对应表字段core_address.type
     */
    @Doc(value="类型", remark="地点所属类型比如1小区、2分区、3楼宇、4单元、5附属之类的")
    private Integer type;

    @Doc(value = "上级地点", remark = "")
    private com.Address parentAddr;

    @Doc(value = "子级地点", remark = "")
    private List<com.Address> childAddrs;

    /**
     * 层级 parentID为0的是第一级，以此递增
     * 对应表字段core_address.level
     */
    @Doc(value="层级", remark="parentID为0的是第一级，以此递增")
    private Integer level;
}

{
    "status": "[int] 调用接口是否成功，0：失败，1：成功",
    "errorCode": "[string] 错误码，当status=0时，必须返回错误码",
    "message": "[string] 错误具体信息",
    "data": [{
        "timeList": [{
            "id": "[long] id",
            "dealerId": "[long] 经销商id",
            "optionalTime": "[string] 试驾可选时间",
            "isChoose": "[int] 是否选择【1=是，0=否】",
            "seq": "[int] 序号",
            "creatorId": "[long] 创建人",
            "creator": "[string] 创建人",
            "createTime": "[date] 创建时间",
            "lastUpdatorId": "[long] 最后更新人",
            "lastUpdator": "[string] 最后更新人",
            "lastUpdateTime": "[date] 最后更新时间",
            "remark": "[string] 备注"
        }],
        "date": "[string] ",
        "time": "[string] ",
        "week": "[string] "
    }]
}

    <properties>
        <!-- 文档管理系统地址 -->
        <doc.host>http://10.201.78.119</doc.host>
        <!-- 接口所属项目名称 -->
        <doc.project>demo</doc.project>
        <!-- 接口响应数据最大解释到第几层 -->
        <doc.maxlevel>4</doc.maxlevel>
        <!-- 扫描指定包下的接口类 -->
        <doc.scan.base>org.basecode.web</doc.scan.base>
        <!-- 响应统一包装类 -->
        <doc.data.rootClass>org.basecode.common.criterion.model.ResultMsg</doc.data.rootClass>
    </properties>

    <!-- 生成接口文档 -->
    <profiles>
        <profile>
            <id>doc</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.codehaus.mojo</groupId>
                        <artifactId>exec-maven-plugin</artifactId>
                        <version>1.6.0</version>
                        <executions>
                            <execution>
                                <phase>install</phase>
                                <goals>
                                    <goal>java</goal>
                                </goals>
                                <configuration>
                                    <mainClass>com.dashu.lazyapidoc.process.CreateApi</mainClass>
                                    <cleanupDaemonThreads>false</cleanupDaemonThreads>
                                    <arguments>
                                        <argument>${doc.host}</argument>
                                        <argument>${doc.project}</argument>
                                        <argument>${doc.maxlevel}</argument>
                                        <argument>${doc.scan.base}</argument>
                                        <argument>${doc.data.rootClass}</argument>
                                    </arguments>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

mvn clean -Pdoc install

@RestController
@RequestMapping(value="/api_permission")
@Doc("api权限管理")
public interface ApiPermissionService extends GenericBaseService<ApiPermission>{
    ...
}

@IgnoreParameter(ignore = {"orderBy", "sord"})
@IgnoreParameter(value = "orderBy,sord")
@IgnoreParameter("orderBy,sord")

@RequireParameter(require = {"page", "rows"})
@RequireParameter(value = "page,rows")
@RequireParameter("page,rows")