swagger

背景:
          1.架构革新,前后端分离,微服务,服务端只需提供RESTful API
          2. 构建RESTful API会考虑到多终端的问题,多个开发人员甚至多个开发团队  
          3.API接口文档 :减少团队间沟通成本
          4.开发期间接口会因业务的变更频繁而变动
          
   swagger:
         场景:
                   1.接口文档
                   2.接口调试
                   支持聚合文档,满足微服务的开发模式

         应用:
               通过一系列注解生成强大的API文档
               常用注解:
                  @Api()用于类; 表示标识这个类是swagger的资源 
                  @ApiOperation()用于方法; 表示一个http请求的操作 
                  @ApiParam()用于方法,参数,字段说明; 表示对参数的添加元数据(说明或是否必填等)
                  @ApiModel()用于类 表示对类进行说明,用于参数用实体类接收 
                  @ApiModelProperty()用于方法,字段 表示对model属性的说明或者数据操作更改 
                  @ApiIgnore()用于类,方法,方法参数 表示这个方法或者类被忽略 
                  @ApiImplicitParam() 用于方法 表示单独的请求参数 
                  @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam    

你可能感兴趣的:(架构)