brief

@brief是自定义taglet。

接口列表区域展示的是属于某标签的接口列表,主要以接口的访问地址呈现。为了方便文档使用者在浏览接口列表时快速找到所需接口,通过@brief对接口进行简要描述,该描述会加在接口列表区域中的接口地址前。如果没有主动添加@brief,就会利用接口的注释生成摘要作为默认的接口描述。

/**
 * @brief list课程 
 */
@RequestMapping(value = {"/class/list","/class/listclass"}, method = RequestMethod.GET)
public @ResponseBody
List<Clazz> listClass(HttpServletRequest httpRequest,
        HttpServletResponse httpResponse) {
    LinkedList<Clazz> result = new LinkedList<Clazz>();
    result.add(new Clazz());
    return result;
}

/**
 * 
 添加课程列表. 添加
 完后返回添加结果。
 */
@RequestMapping(value = "/class/addlist", method = RequestMethod.POST)
public @ResponseBody
boolean addClassList(@RequestBody List<Clazz> clazz, HttpServletRequest httpRequest,
        HttpServletResponse httpResponse) {
    return true;
}

APIList

results matching ""

    No results matching ""