zoukankan      html  css  js  c++  java
  • SPRINGBOOT集成SWAGGER2

    1、代码变更,文档跟着代码变、只需要少量的注解Swagger就可以根据代码自动的生成API文档,很好的保证了文档的实时性。

      2、跨语言,Swagger支持40多种语言。

      3、Swagger UI 呈现出来的是一份可以交互的API文档,我们可以直接在文档页面尝试API的调用,省去了准备复杂的调用参数的过程。

      4、还可以将文档规范导入相关的工具里面(例如:Postman、SoapUI)、这些工具将会为我们自动地创建自动化测试。
    常见注解简介
    @Api:修饰整个类,描述Controller的作用
    @ApiOperation:描述一个类的一个方法,或者说一个接口
    @ApiParam:单个参数描述
    @ApiModel:用对象实体来作为入参
    @ApiProperty:用对象接实体收参数时,描述对象的一个字段
    @ApiResponse:HTTP响应其中1个描述
    @ApiResponses:HTTP响应整体描述
    @ApiIgnore:使用该注解忽略这个API
    @ApiError :发生错误返回的信息
    @ApiImplicitParam:一个请求参数
    @ApiImplicitParams: 多个请求参数

  • 相关阅读:
    java多线程--线程和线程池
    java多线程--锁学习
    vue项目中使用iconfont
    组件封装-无数据组件
    添加自定义字体
    时间格式化(自定义格式)
    深度克隆方法
    LazyMan面试题
    lodash.throttle实现节流
    第6章:关系数据库理论(考研重点)
  • 原文地址:https://www.cnblogs.com/chen991126/p/14145702.html
Copyright © 2011-2022 走看看