swagger2 配置以及简单使用
博客专区 > pacey 的博客 > 博客详情
swagger2 配置以及简单使用
pacey 发表于3个月前
swagger2 配置以及简单使用
  • 发表于 3个月前
  • 阅读 7
  • 收藏 0
  • 点赞 0
  • 评论 0

腾讯云 新注册用户 域名抢购1元起>>>   

swagger是什么:

  1. Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码,了解更多内容,见参考资料。  
  2. Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

 

1、配置

    1>首先加入swagger依赖;

<!-- swagger -->
<dependency>
    <groupId>com.mangofactory</groupId>
    <artifactId>swagger-springmvc</artifactId>
    <version>1.0.2</version>
</dependency>

    2>加入swagger初始化配置

 <!-- swagger配置信息 -->
    <bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />

2、注解详解:

    1>@Api注解,用户类,表示标识这个类是swagger的资源:

        value:同RequestMapping,未加“/”,swagger会默认加上

        description:简单描述

        basePath:基础路径,swagger会自动衍生

        position:资源清单中此API资源的可选的显式排序。默认值是0

        produces:返回contentType类型,如application/json

        consumes:请求contentType类型,如application/x-www-form-urlencoded

        hidden:是否隐藏,默认false

    2>@ApiOpertion注解,用于方法,表示一个http请求的操作:

        value:在swagger-ui显示的名称

        notes:简单描述

        response:返回类型,.class        

        httpMethod:http请求方法

        nickname:被用在第三方工具中区分操作的名称,默认为方法名,可以重写

        produces,consumes,hidden同Api中一样。

    3>ApiParam注解,用在请求参数上:

        name:参数名 
        value:参数说明 
        required:是否必填

 

    4>ApiModel注解用于类 ,表示对类进行说明,用于参数用实体类接收 
        value:表示对象名 
        description:描述

        parent:父类.class (较少使用)

        subTypes:数组class,从该模型继承的子类型数组。(较少使用)

 

    5>ApiModelProperty注解用于方法,字段; 表示对model属性的说明或者数据操作更改 
        value:字段说明 
        name:重写属性名字 
        dataType:重写属性类型 
        required:是否必填 
        example:举例说明 

       allowableValues:允许接受的值,可对参数进行判断。

    6>ApiIgnore注解用于类或者方法上,可以不被swagger显示在页面上 

    7>@ApiImplicitParam() 用于方法 ,表示单独的请求参数 
    8>@ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam 
 

共有 人打赏支持
粉丝 0
博文 25
码字总数 8465
×
pacey
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: