文档章节

swagger2 配置以及简单使用

pacey
 pacey
发布于 2017/09/06 17:43
字数 620
阅读 10
收藏 0

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 
 

© 著作权归作者所有

共有 人打赏支持
pacey
粉丝 0
博文 25
码字总数 8465
作品 0
闵行
私信 提问
使用Swagger2构建Spring Boot RESTful AIP 文档

上一篇我们介绍了如何使用Spring Boot快速构建RESTful API “Spring Boot与RESTful API ” ,本篇则介绍一个配合Spring Boot快速构建RESTful文档的工具 由于Spring Boot具有快速开发、便捷部...

老虎是个蛋蛋
2016/12/23
1K
5
阿信sxq/SpringBootSwaggerStarter

SpringBootSwaggerStarter 在spring-boot中使用swagger,可以实现对代码无侵入地集成swagger 使用时的项目配置 需要在spring boot项目中使用,下面按照使用maven构建项目,以及使用文件来配置...

阿信sxq
2017/07/21
0
0
Spring mvc整合swagger2。

看到http://git.oschina.net/didispace/SpringBoot-Learning 的时候突然发现一个好玩的东西swagger2,是spring boot整合的。那么不用spring boot有没有办法呢,突然一下来感觉了就试试了。肯定...

z201
2016/08/04
308
0
Spring Boot中使用Swagger2生成RESTful API文档(转)

效果如下图所示: 添加Swagger2依赖 在中加入Swagger2的依赖 注意:如果是2.2版本的,有可能在右下角会出现错误,那么请升级为2.7版本的即可解决这个问题。 创建Swagger2配置类 在同级创建S...

easonjim
2017/09/13
0
0
使用RESTful风格开发Java Web

什么是RESTful风格? REST是REpresentational State Transfer的缩写(一般中文翻译为表述性状态转移),REST 是一种体系结构,而 HTTP 是一种包含了 REST 架构属性的协议,为了便于理解,我们...

我没有三颗心脏
05/29
0
0

没有更多内容

加载失败,请刷新页面

加载更多

RabbitMQ+PHP 教程三(Publish/Subscribe)用yii2测试通过

介绍 在前面的教程中,我们创建了一个工作队列。工作队列背后的假设是每个任务都交付给一个工作人员处理。在这一部分中,我们将做一些完全不同的事情——我们将向多个消费者发送消息。此模式...

hansonwong
23分钟前
2
0
关于JAVA你必须知道的那些事(四):单例模式和多态

好吧,今天一定要把面向对象的最后一个特性:多态,给说完。不过我们先来聊一聊设计模式,因为它很重要。 设计模式 官方的解释是,设计模式是:一套被反复使用,多数人知晓的,经过分类编目,...

拾光TM
23分钟前
1
0
ES6 系列之 Babel 是如何编译 Class 的(下)

摘要: ## 前言 在上一篇 [《 ES6 系列 Babel 是如何编译 Class 的(上)》](https://github.com/mqyqingfeng/Blog/issues/105),我们知道了 Babel 是如何编译 Class 的,这篇我们学习 Babel ...

阿里云官方博客
24分钟前
1
0
附实例!实现iframe父窗体与子窗体的通信

欢迎大家前往腾讯云+社区,获取更多腾讯海量技术实践干货哦~ 本文由前端林子发表于云+社区专栏 本文主要会介绍如何基于MessengerJS,实现iframe父窗体与子窗体间的通信,传递数据信息。同时本...

腾讯云加社区
30分钟前
1
0
JSP页面传List集合到Action中

1:JSP页面(前端用的是H-UI框架) <div class="codeView docs-example"> <table class="table table-border table-bordered table-striped"> <thead> ......

uug
33分钟前
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部