Param Configuration Reference

原理

smalldoc基于 Java源码 、标准注释 以及 Tag 生成文档，所以，参数配置也是基于这三项内容进行的。

1.忽略解析指定参数

在某些情况下，接口所对应method的参数并不需要展示在文档中，例如

@RequestMapping("/test")
public void test(String p, @RequestHeader(HttpHeaders.HOST) String host, HttpServletRequest request, HttpServletResponse response);

上述接口的参数中，

• host 对应着某个请求头，从请求对象中拿取，不需要明确传递，所以无需展示在接口文档中；
• request 、response 分别对应着请求对象与响应对象，无关传参传递，也不需要展示；

所以在上述接口中，只有参数 p 需要展示在文档中。smalldoc是否解析方法的某个参数，取决于在该方法的注释中是否存在对应的@param标签，所以上述接口注释只需要这样写

/**
 * 测试接口
 *
 * @param p
 */
@RequestMapping("/test")
public void test(String p, @RequestHeader(HttpHeaders.HOST) String host, HttpServletRequest request, HttpServletResponse response);