请选择 进入手机版 | 继续访问电脑版
本站特色:极好的技术研究氛围!所有技术交流,必有回复!

疯狂Java联盟

 找回密码
 加入联盟
查看: 479|回复: 1

使用Swagger2构建强大的RESTful API文档(2)

[复制链接]
发表于 2018-6-25 17:36:34 | 显示全部楼层 |阅读模式
在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,而描述主要来源于函数等命名产生,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。如下所示,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams@ApiImplicitParam注解来给参数增加说明。
  1. @RestController  
  2. @RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下,可去除  
  3. public class UserController {  
  4.   
  5.     static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());  
  6.   
  7.     @ApiOperation(value="获取用户列表", notes="")  
  8.     @RequestMapping(value={""}, method=RequestMethod.GET)  
  9.     public List<User> getUserList() {  
  10.         List<User> r = new ArrayList<User>(users.values());  
  11.         return r;  
  12.     }  
  13.   
  14.     @ApiOperation(value="创建用户", notes="根据User对象创建用户")  
  15.     @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")  
  16.     @RequestMapping(value="", method=RequestMethod.POST)  
  17.     public String postUser(@RequestBody User user) {  
  18.         users.put(user.getId(), user);  
  19.         return "success";  
  20.     }  
  21.   
  22.     @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")  
  23.     @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")  
  24.     @RequestMapping(value="/{id}", method=RequestMethod.GET)  
  25.     public User getUser(@PathVariable Long id) {  
  26.         return users.get(id);  
  27.     }  
  28.   
  29.     @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")  
  30.     @ApiImplicitParams({  
  31.             @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),  
  32.             @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")  
  33.     })  
  34.     @RequestMapping(value="/{id}", method=RequestMethod.PUT)  
  35.     public String putUser(@PathVariable Long id, @RequestBody User user) {  
  36.         User u = users.get(id);  
  37.         u.setName(user.getName());  
  38.         u.setAge(user.getAge());  
  39.         users.put(id, u);  
  40.         return "success";  
  41.     }  
  42.   
  43.     @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")  
  44.     @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")  
  45.     @RequestMapping(value="/{id}", method=RequestMethod.DELETE)  
  46.     public String deleteUser(@PathVariable Long id) {  
  47.         users.remove(id);  
  48.         return "success";  
  49.     }  
  50.   
  51. }  
复制代码
完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html

。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求,以POST类型的/users请求为例,可找到上述代码中我们配置的Notes信息以及参数user的描述信息,如下图所示。

PO.png

API文档访问与调试

在上图请求的页面中,我们看到user的Value是个输入框?是的,Swagger除了查看接口功能外,还提供了调试测试功能,我们可以点击上图中右侧的Model Schema(黄色区域:它指明了User的数据结构),此时Value中就有了user对象的模板,我们只需要稍适修改,点击下方“Try it out!”按钮,即可完成了一次请求调用!

此时,你也可以通过几个GET请求来验证之前的POST请求是否正确。

相比为这些接口编写文档的工作,我们增加的配置内容是非常少而且精简的,对于原有代码的侵入也在忍受范围之内。因此,在构建RESTful API的同时,加入swagger来对API文档进行管理,是个不错的选择。


 楼主| 发表于 2018-6-25 17:36:56 | 显示全部楼层
感兴趣的可以企鹅 壹玖零叁八叁贰伍柒玖
您需要登录后才可以回帖 登录 | 加入联盟

本版积分规则

微信群请扫二维码
QQ交流1群:
545923995
(未满)

小黑屋|手机版|Archiver|疯狂Java联盟 ( 粤ICP备11094030号 )

GMT+8, 2020-3-30 03:25 , Processed in 0.251650 second(s), 7 queries , File On.

快速回复 返回顶部 返回列表