在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,而描述主要来源于函数等命名产生,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。如下所示,我们通过@ApiOperation注解来给API增加说明,通过@ApiImplicitParams, @ApiImplicitParam注解来给参数增加说明。
<>以前@RestController @RequestMapping (value=https://www.yisu.com/zixun//用户)//通过这里配置使下面的映射都在/用户下,可去除 公开课用户控件{ 静态地图=<长,用户>用户集合。synchronizedMap(新HashMap <长,用户> ()); @ApiOperation (value="获取用户列表”,指出=" ") @RequestMapping(值={"},方法=RequestMethod.GET) 公共列表<用户> getUserList () { <用户列表> r=新ArrayList <用户> (users.values ()); 返回r; } @ApiOperation (value="创建用户”,指出=案萦没Ф韵蟠唇ㄓ没А? @ApiImplicitParam (name="用户" value="用户详细实体用户”,要求=true,数据类型=坝没А? @RequestMapping (value="、方法=RequestMethod.POST) 公共字符串postUser (@RequestBody用户用户){ users.put (user.getId()、用户); 返回“成功”; } @ApiOperation (value="获取用户详细信息”,指出=案輚rl的id来获取用户详细信息”) @ApiImplicitParam (name=" id " value="用户id”,要求=true,数据类型=俺ぁ? @RequestMapping (value="/{id}”、方法=RequestMethod.GET) 公共用户getUser (@PathVariable长id) { 返回users.get (id); } @ApiOperation (value="更新用户详细信息”,指出=案輚rl的id来指定更新对象,并根据传过来的用户信息来更新用户详细信息”) @ApiImplicitParams ({ @ApiImplicitParam (name=" id " value="用户id”,要求=true,数据类型=俺ぁ?, @ApiImplicitParam (name="用户" value="用户详细实体用户”,要求=true,数据类型=坝没А? }) @RequestMapping (value="/{id}”、方法=RequestMethod.PUT) 公共字符串putUser (@PathVariable id, @RequestBody用户用户){ 用户u=users.get (id); u.setName (user.getName ()); u.setAge (user.getAge ()); 用户。把(id, u); 返回“成功”; } @ApiOperation (value="删除用户”,指出=案輚rl的id来指定删除对象”) @ApiImplicitParam (name=" id " value="用户id”,要求=true,数据类型=俺ぁ? @RequestMapping (value="/{id}”、方法=RequestMethod.DELETE) 公共字符串deleteUser (@PathVariable长id) { users.remove (id); 返回“成功”; } }
