自定义接口路由

本章节介绍的内容相对少见，如果你的服务框架并未涉及此类使用方式可以快速跳过本节。

在Spring MVC的使用中，我们通常使用@RequestMapping注解进行URL路由。但有时候也会遇到一些框架是不使用@RequestMapping注解，它自定义接口路由。这个时候wrdoclet就无法识别服务接口，因此定义了一些taglet辅助生成接口文档。

@api标注某个函数是服务接口。其后所跟的注释为访问该接口的方法类型（可选）和URI。 比如：

@api GET /class/query

@api /student/add

@api也可以直接标注在接口所在的类上面，表示该类中接口的基准URI。

比如下面query的接口URI最终会显示为 GET /class/query

/**
 * @api /class/
 */
public class ClazzHandler {
    /**
     * @api GET query
     */
    public void query(HttpServletRequest req, HttpServletResponse resp) {
    }
}

@refReq标注服务接口的入参。其后所跟的注释为入参名以及入参类型(类类型的全名)。

@refResp标注服务接口的出参。其后所跟的注释为出参类型(类类型的全名)

下面就是一个例子。

/**
 * 自路由用例
 * @api /class/foo
 * @refReq body net.winroad.Models.Clazz
 * @refResp net.winroad.Models.Address
 */
public void foo(HttpServletRequest httpRequest,
        HttpServletResponse httpResponse) {

}