一凡码农 · 1月13日

spring boot2集成api文档工具swagger-ui(下)

接上篇

swaggerUI提供了可视化界面帮助我们管理服务的访问路口,这就需要我们在代码中规范我们的书写格式。并且在swagger的界面上还能够模拟浏览器对服务进行访问。

接口总览

创建POST接口

  • 创建一个保存用户的接口
    @RequestMapping(value = "/addUser",method = RequestMethod.POST)
    @ApiModelProperty(value="user",notes = "用户信息的json串")
    @ApiOperation(value = "新增用户", notes="返回新增的用户信息")
    public Object adduser(@RequestBody User user){

        Map map = new HashMap();
        map.put("msg","success");
        map.put("code","1");
        return map;
    }

创建一个PUT接口

  • 修改用户接口
@RequestMapping(value = "/updateUser",method = RequestMethod.PUT)
    @ResponseBody
    @ApiModelProperty(value="user",notes = "修改后用户信息的json串")
    @ApiOperation(value = "更新用户信息", notes="返回更新的用户信息")
    public Map<String,Object> updateUser(@RequestBody User user) {

        Map map = new HashMap();
        map.put("msg","success");
        map.put("code","1");
        return map;
    }

创建一个GET接口

  • 创建获取用户信息的接口

    @RequestMapping(value = "/byname", method = RequestMethod.GET)
    @ResponseBody
    @ApiImplicitParam(paramType = "query",name= "username" ,value = "用户名",dataType = "string")
    @ApiOperation(value = "通过用户名获取用户信息", notes="返回用户信息")
    public Object byname(@RequestParam @ApiParam(name="username",value="名字",required = true)String username) {
        Map map = new HashMap();
        map.put("msg","success");
        map.put("code","1");
        return map;

    }

创建一个DELETE接口


    @RequestMapping(value = "/deleteUser", method = RequestMethod.DELETE)
    @ResponseBody
    @ApiOperation(value = "通过id删除用户信息", notes="返回删除状态1 成功 0 失败")
    public Map<String,Object> deleteUser(@RequestParam @ApiParam(name="id",value="id",required = true) Integer id) {
        Map map = new HashMap();
        map.put("msg","success");
        map.put("code","1");
        return map;
    }

总结

本文项目代码地址:
https://gitee.com/Qinux/sprin...

0 阅读 373
推荐阅读
0 条评论
关注数
0
文章数
5
目录
极术微信服务号
关注极术微信号
实时接收点赞提醒和评论通知
Arm中国学堂公众号
关注Arm中国学堂
实时获取免费 Arm 教学资源信息
Arm中国招聘公众号
关注Arm中国招聘
实时获取 Arm 中国职位信息