Swagger2的简单介绍和使用
1.Swagger2是什么?
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
2.Swagger2的特点是什么?
(1) 及时性 (接口变更后,能够及时准确地通知相关前后端开发人员)
(2)规范性 (并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
(3)一致性 (接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
(4)可测性 (直接在接口文档上进行测试,以方便理解业务
3、Swagger2的快速使用
(1).创建普通springboot项目并引入相关依赖.当然也可以创建maven再变成springboothttps://blog.csdn.net/weixin_46258873/article/details/114680250
<!--swagger--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.4.0</version><scope>provided </scope>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.4.0</version><scope>provided </scope>
</dependency>
(2)创建包com.chang.config,创建类SwaggerConfig
package com.chang.config;import com.google.common.base.Predicates;
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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration
@EnableSwagger2//=======注意开启,否则无法使用
public class SwaggerConfig {@Beanpublic Docket webApiConfig(){return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select().paths(Predicates.not(PathSelectors.regex("/admin/.*"))).paths(Predicates.not(PathSelectors.regex("/error.*"))).build();}private ApiInfo webApiInfo(){return new ApiInfoBuilder().title("网站-课程中心API文档").description("本文档描述了课程中心微服务接口定义").version("1.0").contact(new Contact("Helen", "http://chang.com", "55317332@qq.com")).build();}
}
注意:不使用@EnableSwagger2注解会报以下错误
(3)在我们要使用swagger的其它工程中导入上面工程的依赖。如
<dependencies><dependency><groupId>com.chang</groupId><artifactId>service-base</artifactId><version>0.0.1-SNAPSHOT</version></dependency></dependencies>
(4)在我们要使用swagger的其它工程中的启动类上添加注解,进行测试,访问路径如下:http://localhost:8001/swagger-ui.html
@SpringBootApplication
@EnableSwagger2
@ComponentScan("com.chang")//swagger2所在的部分包名
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class,args);}
}
(5)可忽略这一步,定义接口说明和参数说明
定义在类上:@Api
定义在方法上:@ApiOperation
定义在参数上:@ApiParam
@Api(description="讲师管理")
@RestController
@RequestMapping("/eduService/teacher")
public class TeacherController {@Autowiredprivate TeacherService teacherService;@GetMapping("/findAll")@ApiOperation(value = "所有讲师列表")public List<Teacher> findAllTeacher(){return teacherService.list(null);}@ApiOperation(value = "根据ID删除讲师")@DeleteMapping("/{id}")public boolean deleteById(@ApiParam(name = "id", value = "讲师ID", required = true)@PathVariable String id){return teacherService.removeById(id);}
}
常见问题https://zhaoxuyang.com/springboot%E4%BD%BF%E7%94%A8swagger2%E5%87%BA%E7%8E%B0unable-to-infer-base-url-this-is-common-when-using-dynamic-servlet-registration-or-when-the-api-is-behind-an-api-gateway/
Swagger2的简单介绍和使用相关推荐
- 遗传算法的简单介绍以及模式定理的简单证明
遗传算法 遗传算法(Genetic Algorithm,GA),最早是由美国的John holland在20世纪70年代提出.算法通过模拟达尔文生物进化论的自然选择以及遗传学机理的生物进化过程来搜 ...
- 2021年大数据ELK(十八):Beats 简单介绍和FileBeat工作原理
全网最详细的大数据ELK文章系列,强烈建议收藏加关注! 新文章都已经列出历史文章目录,帮助大家回顾前面的知识重点. 目录 Beats 简单介绍和FileBeat工作原理 一.Beats 二.FileB ...
- 2021年大数据ELK(十五):Elasticsearch SQL简单介绍
全网最详细的大数据ELK文章系列,强烈建议收藏加关注! 新文章都已经列出历史文章目录,帮助大家回顾前面的知识重点. 目录 Elasticsearch SQL简单介绍 一.SQL与Elasticsear ...
- 2021年大数据ELK(二):Elasticsearch简单介绍
全网最详细的大数据ELK文章系列,强烈建议收藏加关注! 新文章都已经列出历史文章目录,帮助大家回顾前面的知识重点. 目录 系列历史文章 一.Elasticsearch简介 1.介绍 2.创始人 二.E ...
- iOS开发UI篇—多控制器和导航控制器简单介绍
iOS开发UI篇-多控制器和导航控制器简单介绍 一.多控制器 一个iOS的app很少只由一个控制器组成,除非这个app极其简单.当app中有多个控制器的时候,我们就需要对这些控制器进行管理 有多个vi ...
- 简单介绍一下R中的几种统计分布及常用模型
统计学上分布有很多,在R中基本都有描述.因能力有限,我们就挑选几个常用的.比较重要的简单介绍一下每种分布的定义,公式,以及在R中的展示. 统计分布每一种分布有四个函数:d――density(密度函数) ...
- LVS(Linux Virtual Server)三种负载均衡模型和十种调度的简单介绍
LVS(Linux Virtual Server)三种负载均衡模型和十种调度的简单介绍 LVS (Linux Virtual Server) LVS(Linux Virtual Server)其实就是 ...
- dubbo学习过程、使用经验分享及实现原理简单介绍
一.前言 部门去年年中开始各种改造,第一步是模块服务化,这边初选dubbo试用在一些非重要模块上,慢慢引入到一些稍微重要的功能上,半年时间,学习过程及线上使用遇到的些问题在此总结下. 整理这篇文章差不 ...
- iOS开发UI篇—UIWindow简单介绍
iOS开发UI篇-UIWindow简单介绍 一.简单介绍 UIWindow是一种特殊的UIView,通常在一个app中只会有一个UIWindow iOS程序启动完毕后,创建的第一个视图控件就是UIWi ...
最新文章
- [算法] [常微分方程] [欧拉法 改进欧拉法 经典R-K算法]
- bootstrap的一些资源
- 微软职位内部推荐-Sr. SW Engineer for Privacy Id
- 物联网智能硬件设备常见攻击方法
- Http Post 二进制通信
- c语言指针跨函数使用内存
- mysql的engine不同,导致事物回滚失败的问题
- 使用Ionic3创建原生app系统入门
- Python 经典例题
- Python光的干涉仿真
- 卷积神经网络 神经网络,卷积神经网络基础知识
- 开发者专访|我从「人间地狱」的算法岗内卷中,倔强地踏出了一条路 前路漫漫,星芒万里
- java回调原理,以及Callable和FutureTask通过回调机制创建可监控的线程
- 关于branch XYZ is published (but not merged) and is now N commits behind错误的一点分析
- 华大单片机HC32L136定时器时间如何计算
- linux fstab 远程,linux限制root用户远程ssh登录的...-linux下ssh无密码登录的配置方...-linux下修复fstab文件的方法_169IT.COM...
- ubuntu1704入门教程(一)下载安装
- 每日一句:day01——From Zero To Hero
- PAT甲级 1138 后序遍历
- mysql数据库西里尔文乱码_MySQL和PHP:utf-8带有西里尔字符