文档章节

swagger2 配置以及简单使用

pacey
 pacey
发布于 2017/09/06 17:43
字数 620
阅读 8
收藏 0
点赞 0
评论 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 Boot中使用Swagger2生成RESTful API文档(转)

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

easonjim
2017/09/13
0
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 mvc整合swagger2。

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

z201
2016/08/04
308
0
spring boot 1.5.4 集成Swagger2构建Restful API(十八)

上一篇博客地址:springboot 1.5.4 整合rabbitMQ(十七) 1 Spring Boot集成Swagger2构建RESTful API文档 1.1 Swagger2简介 Swagger2官网:http://swagger.io/ 由于Spring Boot能够快速开发、...

wyait
2017/11/03
0
0
Spring Boot中使用Swagger2构建RESTful API文档

随着前后端的分离,借口文档变的尤其重要,今天我们来说一说用SWAGGER2,来风骚的生成api文档。配置很简单,废话少说,直接上代码: build.gradle SwaggerConfig.java DemoApplication.java...

不正经茂
2016/12/02
290
0
基于Maven的Springboot+Mybatis+Druid+Swagger2+mybatis-generator框架环境搭建

前言 最近做回后台开发,重新抓起以前学过的SSM(Spring+Spring MVC+Mybatis),但是发现配置实在过于复杂,好多东西配置起来麻烦,虽然最终是配置出来了,但是还是感觉开发速度跟不上,本来打...

易达
2016/10/15
228
0
SpringBoot集成springfox-swagger2构建restful API

上面文章SpringMVC集成springfox-swagger2构建restful API简单写了如何在springmvc中集成swagger2。这边记录下在springboot中如何集成swagger2。其实使用基本相同。 首先还是引用相关jar包。...

u014231523
2017/01/15
0
0
SpringMVC集成springfox-swagger2构建restful API

在集成springfox-swagger2之前,我也尝试着集成了swagger-springmvc,方式差不多,但是swagger-springmvc相对麻烦一点,因为要把它的静态文件copy到自己的项目中。所以还是用新版本的。 至于...

u014231523
2017/01/13
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

matplotlib 保存图片时的参数

简单绘图 import matplotlib.pyplot as pltplt.plot(range(10)) 保存为csv格式,放大后依然很清晰 plt.savefig('t1.svg') 普通保存放大后会有点模糊文件大小20多k plt.savefig('t5.p...

阿豪boy
8分钟前
0
0
java 8 复合Lambda 表达式

comparator 比较器复合 //排序Comparator.comparing(Apple::getWeight);List<Apple> list = Stream.of(new Apple(1, "a"), new Apple(2, "b"), new Apple(3, "c")) .collect(......

Canaan_
昨天
0
0
nginx负载均衡

一、nginx 负载均衡 拓扑图: 主机信息: 1、负载均衡器1(lb1):192.168.10.205 RHEL7.5 2、负载均衡器2(lb2):192.168.10.206 RHEL7.5 3、web服务器1(web01):192.168.10.207 Centos...

人在艹木中
昨天
0
0
做了一个小网站

做了一个小网站 www.kanxs123.com

叶落花开
昨天
0
0
继社会佩奇之后,又尝试了可爱的蓝胖子,有趣 Python

#哆啦A梦# !/usr/bin/env python3# -*- coding: utf-8 -*-# @Author: dong dong# @Env: python 3.6from turtle import *# 无轨迹跳跃def my_goto(x, y): penup(...

Py爱好
昨天
0
0
shell及python脚本方式登录服务器

一、问题 在工作过程中,经常会遇见需要登录服务器,并且因为安全的原因,需要使用交互的方式登录,而且shell、python在工作中也经常用到,并且可以提供交互的功能。都是利用了expect、spawn...

yangjianzhou
昨天
0
0
upstream sent too big header while reading...

nginx 报错:1736 upstream sent too big header while reading response header from upstream 1. 一般处理 location ~ \.php$ { #增加下面两句 fastcgi_buffer_size 128k; ......

dubox
昨天
0
0
Python解析配置文件模块:ConfigPhaser

import configparser as pa# [SectionA]# a = aa# b = bb# c = cc# [SectionB]# optionint = 1# optionfloat = 1.1# optionstring = string#https://www.cnblogs.com/a......

易野
昨天
0
0
Java基础——面向对象

声明:本栏目所使用的素材都是凯哥学堂VIP学员所写,学员有权匿名,对文章有最终解释权;凯哥学堂旨在促进VIP学员互相学习的基础上公开笔记。 Object的方法: clone() Object 克隆 to Strin...

凯哥学堂
昨天
0
0
rabbitmq学习记录(八)消息发布确认机制

RabbitMQ服务器崩了导致的消息数据丢失,已经持久化的消息数据我们可以通过消息持久化来预防。但是,如果消息从生产者发送到vhosts过程中出现了问题,持久化消息数据的方案就无效了。 Rabbit...

人觉非常君
昨天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部