文档章节

swagger2 配置以及简单使用

pacey
 pacey
发布于 2017/09/06 17:43
字数 620
阅读 9
收藏 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
闵行
阿信sxq/SpringBootSwaggerStarter

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

阿信sxq
2017/07/21
0
0
使用Swagger2构建Spring Boot RESTful AIP 文档

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

老虎是个蛋蛋
2016/12/23
1K
5
Spring mvc整合swagger2。

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

z201
2016/08/04
308
0
程序猿DD/spring-boot-starter-swagger

简介 该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swagger2的整合代码。 源码地址 GitHub:https://github.com/dyc871...

程序猿DD
2017/08/09
0
0
Spring Boot中使用Swagger2生成RESTful API文档(转)

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

easonjim
2017/09/13
0
0

没有更多内容

加载失败,请刷新页面

加载更多

sourcetree 离线免注册登录安装教程

Sourcetree是一个优秀的git可视化管理工具,深受开发者喜爱Sourcetree官网,但是在安装时需要谷歌账户登录,需要翻qiang才可以,此一点一直被人们所诟病。今天本教程就为大家提供离线免登陆安...

QQZZFT
13分钟前
0
0
使用 PostgreSQL 解决一个实际的统计分析问题

使用 PostgreSQL 解决一个实际的统计分析问题作者:老农民(刘启华)Email: 46715422@qq.com 之前有个朋友扔给我一个奇葩需求,他们公司之前做了一批问卷调查,全部都是统一格式的excel...

新疆老农民
16分钟前
0
0
TypeScript基础入门之高级类型的映射类型

转发 TypeScript基础入门之高级类型的映射类型 高级类型 映射类型 一个常见的任务是将一个已知的类型每个属性都变为可选的: interface PersonPartial {    name?: string;    age?...

durban
31分钟前
0
0
Dubbo源码分析(6):Dubbo内核实现之基于SPI思想Dubbo内核实现

SPI接口定义 定义了@SPI注解 package com.alibaba.dubbo.common.extension; import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.an......

郑加威
31分钟前
0
0
RxJS的另外四种实现方式(后记)—— 同时实现管道和链式编程

目录 RxJS的另外四种实现方式(序) RxJS的另外四种实现方式(一)——代码最小的库 RxJS的另外四种实现方式(二)——代码最小的库(续) RxJS的另外四种实现方式(三)——性能最高的库 Rx...

一个灰
34分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部