用户注册



邮箱:

密码:

用户登录


邮箱:

密码:
记住登录一个月忘记密码?

发表随想


还能输入:200字

sc-sc    -  云代码空间

——

Spring Cloud Spring Boot mybatis分布式微服务云架构(十)使用Swag

2018-08-14|689阅||

摘要:Spring Cloud Spring Boot mybatis分布式微服务云架构(十)使用Swagger2构建强大的RESTful API文档(2)

添加文档内容

在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,而描述主要来源于函数等命名产生,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。如下所示,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。


@RestController
@RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下,可去除
public class UserController {
 
    static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());
 
    @ApiOperation(value="获取用户列表", notes="")
    @RequestMapping(value={""}, method=RequestMethod.GET)
    public List<User> getUserList() {
        List<User> r = new ArrayList<User>(users.values());
        return r;
    }
 
    @ApiOperation(value="创建用户", notes="根据User对象创建用户")
    @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    @RequestMapping(value="", method=RequestMethod.POST)
    public String postUser(@RequestBody User user) {
        users.put(user.getId(), user);
        return "success";
    }
 
    @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return users.get(id);
    }
 
    @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })
    @RequestMapping(value="/{id}", method=RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }
 
    @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
        users.remove(id);
        return "success";
    }
 
}

完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求,以POST类型的/users请求为例,可找到上述代码中我们配置的Notes信息以及参数user的描述信息,如下图所示。

altalt

API文档访问与调试

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

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

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


顶 0踩 0收藏
文章评论
    发表评论

    个人资料

    • 昵称: sc-sc
    • 等级: 高级设计师
    • 积分: 7490
    • 代码: 0 个
    • 文章: 302 篇
    • 随想: 0 条
    • 访问: 15 次
    • 关注

    人气代码

      标签

      java(63)api(1)教程(26)Spring(84)cache(1)+(10)springmvc(6)mybatis(10)(十)(1)(十一)(1)Cloud(44)Boot(12)Cloud-hong(1)Cloud分布式微服(1)Cloud-Hong(1)Cloud分布式微服(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud-鸿鹄Cl(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)cloud--鸿鹄C(1)源码(3)简介(1)Cloud微服务分布(1)-(33)cloud集成项目(6)Cloud--Hon(1)Cloud分布式微服(1)Cloud--hon(1)Cloud分布式微服(1)Cloud-鸿鹄Cl(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud微服务分布(1)Cloud微服务分布(1)Cloud-Hong(1)Cloud分布式微服(1)Cloud-鸿鹄Cl(1)使用(1)搭建微服务基础设施(1)Cloud云服务(3)HongHu架构co(1)项目构建过程(5)springclou(1)Eureka服务器搭(1)Cloud--Hon(1)Cloud分布式微服(1)关于Spring(6)Cloud的核心特性(4)Cloud微服务分布(1)Config-快速开(1)Cloud企业微服务(1)Config-快速开(1)Cloud--Hon(1)Cloud分布式微服(1)企业分布式微服务云架(1)Config-快速开(1)Cloud--Hon(1)Cloud分布式微服(1)整合spring(8)cloud云服务架构(11)企业云架构commo(1)企业分布式微服务云架(1)介绍一下Spring(1)Cloud微服务架构(1)总结Spring(4)Cloud各个组件配(1)Config客户端使(1)cloud架构(1)HongHu(1)common-ser(1)RestTempla(1)particle云架(1)Cloud+Spri(1)Boot+Mybat(1)企业分布式微服务云架(1)Config-快速开(1)Config(1)加密和解密(1)Cloud自定义引导(1)Cloud各个组件配(1)Cloud构建微服务(1)Cloud云架构(8)SSO单点登录之OA(1)SSO单点登录之OA(1)Cloud+Spri(1)Boot+Mybat(1)企业分布式微服务云架(1)commonserv(1)4.2.2以上版本和(1)SSO单点登录之OA(1)登出流程(3)(1)Cloud--Hon(1)Cloud分布式微服(1)Netflix(1)Commons(1)普通抽象(1)项目过程构建(1)Cloud微服务分布(1)Cloud微服务分布(1)企业分布式微服务云架(1)Cloud各个组件配(1)云架构代码结构构建(2)Cloud云服务架构(1)分享Spring(1)Cloud分布式微服(1)HongHu架构co(1)企业分布式微服务云架(1)Cloud大型互联网(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud--Hon(1)Cloud分布式微服(1)企业分布式微服务云架(1)Cloud微服务分布(1)Cloud大型互联网(1)Config-Git(1)commonserv(1)cloud微服务分布(1)Cloud微服务分布(1)Cloud微服务分布(1)HongHu架构co(1)Cloud微服务架构(1)Cloud大型互联网(1)Cloud大型互联网(1)Config服务器(1)springclou(1)Cloud-hong(1)Cloud分布式微服(1)SpringClou(1)SpringBoot(73)mybatis分布式(1)SpringClou(1)mybatis分布式(1)mybatis分布式(1)mybatis分布式(1)mybatis分布式(1)Cloud微服务分布(1)Cloud各个组件配(1)(十六)(1)-使用spring(1)企业级(26)(一)(1)(二)(1)(三)(1)cloud项目(2)(五)(1)(六)整合sprin(1)企业云架构commo(1)(七)整合sprin(1)common-ser(1)(八)整合sprin(1)commonserv(1)(十二)(1)(九)整合sprin(1)commonserv(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)java电子商务系统(1)MVC+mybati(1)cloud+spri(1)boot+sprin(1)电子商务云平台b2b(1)b2c(1)o2o(1)springmvc+(1)springclou(1)Cloud简介(1)springclou(1)springclou(1)springclou(1)B2B2C(66)mybatis电子商(1)Springclou(1)Springboot(1)关于SpringCl(1)(九)Java(3)o2o多用户商城(27)(十)Java(1)(十一)Java(1)(十二)(1)springclou(1)springclou(1)springclou(1)SSO单点登录之OA(1)springclou(1)SSO单点登录之OA(1)springclou(1)(十三)java(2)b2b2c多用户商城(6)SSO单点登录之OA(1)(十四)Java(3)springclou(1)springclou(1)(十五)Java(3)springclou(1)springclou(1)(十六)Java(3)springclou(1)springclou(1)(十七)Java(2)springclou(1)springclou(1)springclou(1)springclou(1)java版(1)o2o电子商务云商平(1)Cloud构建分布式(1)Config)(6)ssm(12)springclou(1)springclou(1)企业级java(12)springclou(1)b2bc商城系统开源(1)springclou(1)shop(20)多用户商城系统源码:(2)多用户商城系统源码(3)(十二)java(1)多用户商城系统源码-(2)Bus)(1)Sleuth)(2)springclou(1)springclou(1)SpringClou(1)多级分销Spring(1)高可用的分布式配置中(1)springclou(1)springclou(1)springclou(1)b2b2c多用户商城(1)(十一)JAVA(2)b2bc商城系统开源(1)b2bc商城系统开源(1)b2bc商城系统开源(1)b2b2c多用户商城(1)SpringClou(1)SpringClou(1)SpringClou(1)SpringClou(1)配置管理(1)配置自动刷新(1)springclou(1)springboot(1)(五)springb(1)beatlsql(5)b2b2c多用户商城(1)b2bc商城系统开源(1)(七)springb(1)多用户商城系统(2)(十)用spring(1)(二)Spring(3)Boot配置文件详解(3)整合JPA(1)springclou(1)springclou(1)多用户商城系统源码((1)springclou(1)b2b2c多用户商城(1)(四)断路器(Hys(1)Dashboard)(3)Turbine)(2)o2o分布式(1)b2bc商城系统开源(1)commonserv(1)项目构建过程(八)(1)springclou(1)springclou(1)(十)微服务多用户商(1)b2b2c多用户商城(1)mybatis多租户(1)mybatis多租户(1)mybatis多租户(1)springClou(1)mybatis分布式(1)mybatis多租户(1)(十三)java(1)mybatis仿淘宝(1)微服务java_b2(1)springboot(1)多用户商城系统源码-(1)多用户商城系统源码-(1)(五)JAVA(1)(六)(1)(八)java(1)多用户商城系统源码:(1)微服务b2b2c电子(1)SpringClou(1)springboot(1)SpringClou(1)多用户商城系统源码-(1)springclou(1)springclou(1)springclou(1)springclou(1)b2b2c多用户商城(1)多级分销多租户电子商(1)Dashboard和(1)springclou(1)springclou(1)springclou(1)SpringClou(1)Springclou(1)B2B2C-服务消费(1)(十二)JAVA(1)b2b2c多用户商城(1)Sleuth和Zip(1)(二)企业级java(1)b2bc商城系统开源(1)(三)java(1)springclou(1)springclou(1)springboot(1)Java多用户商城系(1)(一)构建第一个Sp(1)Java版本多用户B(1)Java多用户商城系(1)Dashboard和(1)Java版本多用户B(1)springboot(1)(五)springb(1)springclou(1)springboot(1)SpringBoot(1)多用户商城系统(八)(1)springboot(1)SpringClou(1)springclou(1)b2b2c多用户商城(1)SpringClou(1)springclou(1)springclou(1)(十)springb(1)b2b2c多用户商城(1)b2b2c多用户商城(1)SSO单点登录之OA(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)springboot(1)多级分销Spring(1)整合企业架构的技术点(1)Java版本多用户B(1)Cloud集成项目简(1)springclou(1)springclou(1)Springclou(1)B2B2C-服务消费(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多用户商城系统源码((1)b2bc商城系统开源(1)(十四)服务注册(c(1)多用户商城系统源码((1)b2bc商城系统开源(1)Dashboard和(1)多用户商城系统源码((1)(六)分布式配置中心(1)springclou(1)b2bc商城系统开源(1)多用户商城系统源码-(1)多用户商城系统-(五(1)springboot(1)Java版本多用户B(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多用户商城系统源码-(1)springclou(1)多用户商城系统源码((1)Java多用户商城系(1)-JAVA(1)多用户商城(二)Eu(1)springboot(1)springclou(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多用户商城系统源码((1)微服务java_b2(1)(一)构建第一个Sp(1)springboot(1)Java多用户商城系(1)(三)SpringB(1)多用户商城系统源码((1)多用户商城系统(五)(1)企业分布式微服务云S(1)(十一)docker(1)企业分布式微服务云S(1)(十二)断路器监控((1)企业分布式微服务云S(1)(十三)断路器聚合监(1)企业分布式微服务云S(1)(十四)服务注册(c(1)微服务架构(4)企业分布式微服务云S(1)mybatis(八)(1)企业分布式微服务云S(1)(九)服务链路追踪((1)springclou(1)Sleuth和Zip(1)springclou(1)Sleuth和Zip(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)Dashboard和(1)springclou(1)springclou(1)Dashboard和(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)(六)springb(1)(七)springb(1)(八)springb(1)(九)springb(1)Restdocs创建(1)(十一)spring(1)(十二)spring(1)(十三)spring(1)企业分布式微服务云S(1)(十)高可用的服务注(1)企业分布式微服务云S(1)(十一)docker(1)企业分布式微服务云S(1)(十二)断路器监控((1)企业分布式微服务云S(1)(十三)断路器聚合监(1)企业分布式微服务云S(1)(十四)服务注册(c(1)SpringClou(1)SpringClou(1)SpringClou(1)SpringClou(1)(一)构建第一个Sp(1)(四)(1)(七)(1)(一)构建第一个Sp(1)(三)SpringB(1)(四)SpringB(1)(五)springb(1)(六)springb(1)(七)springb(1)(八)springb(1)(九)springb(1)SpringClou(1)服务的注册与发现(E(1)SpringClou(1)服务消费者(rest(1)SpringClou(1)服务消费者(Feig(1)SpringClou(1)断路器(Hystri(1)SpringClou(1)(五)路由网关(zu(1)SpringClou(1)分布式配置中心(Sp(1)SpringClou(1)高可用的分布式配置中(1)(一)微服务分布式云(1)

      最新提问

        站长推荐