Swagger注解

前言

最近一段时间接触了后端的技术，瞬间感受就是非常的高大上！但是仔细一看也挺简单的，就是调来调取，跟以前学习的知识非常的相似！所以没有太大的难度！但是在Controller层的时候发现注解这个东东，发现挺有意思的！跟大家分享一下

---

What 注解

对于现在的层次可能对于注解的理解还不是太高！还需要不断的去总结，就目前我理解的内容，注解用文字解释就是解释！说明！再进一步说就是我们的注释，但是为什么有注释，还要有用注解呢，注释是给程序员看的，注解是计算机看，由我们的注解告诉电脑去做什么，地址是什么，参数什么，报错内容是什么，这些都是注解告诉电脑，当我们的程序经过反编译 生成目标代码之后你会发现注释会自动消失，但是注解然后存在，这就是注解的作用！

---

在Swagger中我们用到了注解，其实swagger中的注解来自于spring框架中的注解，所以你会感觉到很相似！下面针对代码来说一下关于javaEE中的注解

---

代码

这些注解都是跟我们的swagger产生关联的，API表示说明该类的作用，@post表示提交的方式，@path表示路径， @Consumes消费者， @Produces生产者，@ApiOperation用在方法上，说明方法的作用， @ApiResponses用于表示一组相应，@ApiResponse表示一般用于表示一个错误的响应

   @Api("说明该类的作用")
   @POST
   //与前端连接的路径
   @Path("/addreservetionByMobile")
   //   取参
   @Consumes({"application/json"})
   //   传参
   @Produces({"application/json"})
   //显示提示信息，用在方法上，说明方法的作用
   @ApiOperation(value ="手机端添加预约！Judy测试，userID和Isbn",notes="",response=void.class,tags="reservation")
   //用于表示一组响应
   @ApiResponses(value = {
           // @ApiResponse用在ApiResponses中，一般用户表示一个错误的响应信息
           //code表示数字错误的类型用数字就可以表示，message:信息，response：抛出异常的类
           @ApiResponse(code = 405,message="Invalid input",response=void.class)}

           public ItooResult addreservetionByMobile(@ApiParam(value = "userID和isbn" +
          " to the store", required = true) TReservation tReservation)
           throws NotFoundException,URISyntaxException{
           boolean flag = reserveService.addReserveByMobile(tReservation);
           if(flag){
               return ItooResult.build(SUCCESS,"图书馆信息添加成功",flag);
           }else{
               return ItooResult.build(NOSUCCESS,"图书添加失败",flag);
           }
       }

总结

可能有的地方还是不太懂，需要不断的去深入了解，但是这仅仅是开始，以后会不断的加深映象！要相信自己！