swagger2maven依赖_Swagger2安装及使用
项目开发实现前后端分离,Swagger2是非常好用使用的一个框架!!!真香警告,个人感觉比Postman开发效率提升了很多,注解项会让代码更容易读
在后端开发中经常需要对移动客户端提供RESTful API接口,在后期版本快速迭代的过程中,修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,除非有严格的管理机制,不然很容易导致写出的代码与接口文档不一致现象。
为了前后台更好的对接,为了以后交接方便,为了不再长篇大论的手写api文档,那么就来用Swagger吧(不是打广告),它可以轻松的整合到Spring中,它既可以减少我们手写api文档的时间,同时又将说明文档整合到我们的代码中,这样前台看着也方便,后台工作也舒坦,
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单(其他好处网上自己搜在这里就不再多说了)。
Swagger也提供了强大的页面测试功能来调试每个写好的接口:
1.开发环境
SpringBoot 2.0.4.RELEASE
Swagger 2.6.1
JDK 1.8
2.maven依赖
io.springfox
springfox-swagger2
2.6.1
io.springfox
springfox-swagger-ui
2.6.1
3.Swagger2配置类(以下属于较为基本的属性配置,后期继续增加)
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class Swagger2Config {
@Bean
public Docket createDocket(){
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select().apis(RequestHandlerSelectors.basePackage("com.iflytek.studyproject.controller"))
.paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder().title("Spring boot整合Swagger2学习")
.description("ApiInfo的描述")
.termsOfServiceUrl("no term url")
.version("1.0")
.build();
}
}
@Configuration会被项目启动加载为配置类,等同于XML中配置的beans;
@Bean标注方法等同于XML中配置的bean
4.启动类启动Swagger2(启动类中加入@EnableSwagger2 代表swagger开启:)
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
public class StudyprojectApplication {
public static void main(String[] args) {
SpringApplication.run(StudyprojectApplication.class, args);
}
}
5.定义Restful风格接口
import com.alibaba.fastjson.JSONObject;
import com.iflytek.studyproject.bean.Swagger2Bean;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/swagger2Controller")
public class Swagger2TestController {
@PostMapping("/getSwagger2")
public JSONObject getSwagger2(Swagger2Bean swagger2Bean){
JSONObject put = (JSONObject) new JSONObject().put(swagger2Bean.getId(), swagger2Bean.getName());
return put;
}
}
6.启动
7.Swagger2常用注解
- @Api()用于类;
表示标识这个类是swagger的资源
- @ApiOperation()用于方法;
表示一个http请求的操作
- @ApiParam()用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等)
- @ApiModel()用于类
表示对类进行说明,用于参数用实体类接收
- @ApiModelProperty()用于方法,字段
表示对model属性的说明或者数据操作更改
- @ApiIgnore()用于类,方法,方法参数
表示这个方法或者类被忽略
- @ApiImplicitParam() 用于方法
表示单独的请求参数
- @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam
具体使用举例说明:
@Api()
用于类;表示标识这个类是swagger的资源
tags–表示说明
value–也是说明,可以使用tags替代
但是tags如果有多个值,会生成多个list
swagger2maven依赖_Swagger2安装及使用相关推荐
- swagger2maven依赖_swagger2技术
1.什么是Swagger2? Swagger是一个RESTFUL 接口的文档在线自动生成和功能测试的框架. Swagger 是一个规范和完整的框架.用于生成.描述.调用和可视化RestFul风格的We ...
- 二丶Linux安装xdd-plus教程及必备依赖的安装+青龙对接xdd
二丶Linux安装xdd-plus教程及必备依赖的安装 没有服务器的先自行购买,这里推荐腾讯云2H4G8M首年70–点击购买 **首先需要安装青龙容器没装的青龙容器部署安装及常用命令 QQ交流群:10 ...
- Android 编译环境的依赖库安装
Android的依赖库安装一般是如下: sudo apt-get install -y git gnupg flex bison gperf build-essential zip curl libc ...
- vue脚手架依赖包安装不成功_Windows下vue-cli的搭建
1.vue-cli 是Vue的脚手架工具,windows 下要安装 vue-cli,必须先安装 node.js,才能使用npm. 在cmd里输入node -v,若能出现版本号,则表示已经安装,若不能, ...
- scrapy 的依赖库安装和出现def write(self, data, async=False):的解决方法
scrapy 的依赖库安装和出现def write(self, data, async=False):的解决方法 参考文章: (1)scrapy 的依赖库安装和出现def write(self, da ...
- 【博学谷学习记录】超强总结,用心分享 | 【Lunux】Manjaro手动升级icu依赖库安装MySQL以及Navicat
Manjaro手动升级icu依赖库安装MySQL以及Navicat 之前安装MySQL的时候因为 icu 依赖库版本低数据库初始化失败了,然后用Docker容器安装了MySQL,但是不知道是因为强迫症 ...
- linux rpm安装包忽视所有依赖强制安装
前言 在系统离线情况下,无法通过rpm直接安装依赖包,将rpm包上传到服务器上,linux rpm安装包忽视所有依赖强制安装 解决方法 rpm -Uvh *.rpm --nodeps --force ...
- API接口自动化测试框架搭建(四)-Python依赖环境安装
Python依赖环境安装 1 依赖包及版本 2 依赖包安装方法 2.1 方法一:pip直接装 2.2 方法二:requirements.txt安装 3 目前项目结构 这里单独把Python依赖环境拿出 ...
- GENUS152/INNOVUS152/EXT151依赖包安装(Centos7)
目录 GENUS152/INNOVUS152用InstallScape安装完成后,bashrc也配置完后,打开innovus遇到错误如下: 解决办法: GENUS152.INNOVUS152启动时,图 ...
最新文章
- (已解决)ubuntu20.04 jar xvf XXX.zip报错-java.io.EOFException:Unexpected end of ZLIB input stream
- MATLAB从入门到精通-机械动力学仿真-Amesim仿真实例:对于任意的外力作用下的机械动力学仿真
- linux查看目录文件系统,ubuntu linux 文件系统目录结构-Windows下查看电脑信息的命令-linux菜鸟也必须知道的几个ubuntu最基础命令_169IT.COM...
- VS远程开发(远程调试)编译报错:对‘xxx’未定义的引用(设置库依赖顺序)(已解决)pthread(项目-->属性-->链接器-->输入-->库依赖项)
- charles基本使用文档
- 呼叫我或异步REST
- matlab编程实现二进制树搜索,数据结构: 二进制搜索树(用C语言实现)
- java泛型中?和T有什么区别
- Python在SQL Server管理中的重要性
- JavaScript高级程序设计读书笔记(第8章BOM之location对象查询字符串参数)
- 提高jQuery的性能
- 多线程TCP客户端的设计
- Atitit table的读取解析from html by jsoup java html paresr 目录 1. atitit.gui控件的定位与选择器	1 2. 读取表格流程 遍历表格ta
- 计算机课小组主题作业,小组作业软件工程课程设计(选作).doc
- 非均匀三次B样条曲线插值实现及MATLAB代码
- 【码上实战】【立体匹配系列】经典AD-Census: (1)框架
- 工作邮箱怎么注册?企业邮箱有哪些功能?
- postgresql时区
- Python之复制的cookie参数处理成规整的参数值
- [CTF]No.0006 [强网杯] Who are you