什么是Swagger？

是一个开源的API Doc的框架

可以将我们的Controller中的API方法以文档的形式展现，并支持为其添加注释并实时与后端代码同步
我们可以通过Swagger测试后端接口的运行情况，这就使得前端人员可以实时看到最新API，与后端进行集成联调，避免集成问题集中爆发。

Swagger的具体使用

一、导入依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

二、建立Swagger配置类

@Configuration
@EnableSwagger2         //开启swagger2
public class SwaggerConfig {@Beanpublic Docket docket(Environment environment){Profiles profiles = Profiles.of("dev");boolean enable = environment.acceptsProfiles(profiles);        //根据当前开发环境来决定是否要运行swaggerreturn new Docket(DocumentationType.SWAGGER_2).groupName("InformationController")      //我们通过建立多个Docket类并给不同的groupname区分不同人员的文档// 修改swagger-ui.html界面的基础显示信息.apiInfo(apiInfo())//判断是否是开发模式，来决定是否开启swagger2.enable(enable)// apis 配置扫描接口的方式.select().apis(RequestHandlerSelectors.basePackage("com.wyw.checkinsystem.Controller"))  //限定扫描的Controller目录.paths(PathSelectors.ant("/loginstu"))          //限定扫描的请求链接.build();//被Controller return的实体类都会显示在model中,我们也可以通过注释标注，为Models添加信息//同样，我们可以使用另外两个注释，为controller中的方法及其参数添加信息}private ApiInfo apiInfo(){Contact contact = new Contact("name", "", "");return new ApiInfo("Ostrich5yw Api Documentation","Api Documentation","1.0","urn:tos",contact,"Apache 2.0","http://www.apache.org/licenses/LICENSE-2.0",new ArrayList<VendorExtension>());}

三、通过Swagger测试接口

我们通过Swagger可以直接填入数据请求来测试Controller中的接口
PS:进入http://localhost:端口号/swagger-ui.html查看swagger日志

引用

本文根据遇见狂神说的Docker视频编写。

Springfox-swagger使用详解相关推荐

Swagger Annotation 详解（建议收藏）
转载:https://www.jianshu.com/p/b0b19368e4a8 在软件开发行业,管理文档是件头疼的事.不是文档难于撰写,而是文档难于维护,因为需求与代码会经常变动,尤其在采用敏捷软 ...
Swagget技术·SpringBoot继承Swagger框架详解！
文章目录一.Swagger简介二.SpringBoot集成Swagger 三.配置Swagger 1.Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger. ...
swagger使用详解
1:认识Swagger Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法 ...
Spring MVC学习总结（8）——Swagger入门详解
前言 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件.本文简单介绍了在项目中集成swagger的方法和一些常见问题.如果想深入分析项目源码,了解更多内容,见参考资料. S ...
Swagger工具详解
前言小编前几天在学习了Swagger,一直都处于迷迷糊糊的,不太明白他的优势,单纯的认为只是提供给我们一个界面用于前后台的交互,其实还有很多其他的功能 What Swagger swagger表示用 ...
Swagger注解详解
目录 1. @Api 2. @APiOperation 3. @ApiImplicitParams 4. @ApiResponses 5. @ApiModel 6. @ApiModelProperty ...
什么是swagger以及swagger注解详解
1.什么是swagger Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言 ...
Django REST FRAMEWORK swagger（一）框架详解
Django REST FRAMEWORK swagger(一.框架详解) 一.Django REST SWAGGER框架图具体见下图二.说明 RESTFul说明每一个URI代表一种资源: 客 ...
Java学习日报—Swagger介绍与布隆过滤器详解—2021/12/01
目录 1. Swagger 1.1 介绍 1.2 Swagger 的优势 1.3 简单使用 1.3.1 集成 Swagger 管理 API 文档 1.3.2 在线测试接口 1.4 常用注解 1.5 参 ...
swagger文档增强工具knife4j使用详解
本文从本人博客搬运,原文格式更加美观,可以移步原文阅读:swagger文档增强工具knife4j使用详解使用原生的swagger作为接口文档,功能不够强大,并且默认的ui比较简陋,不符合大众审美.所 ...

Springfox-swagger使用详解

Springfox-swagger使用详解

什么是Swagger？

Swagger的具体使用

一、导入依赖

二、建立Swagger配置类

三、通过Swagger测试接口

引用

Springfox-swagger使用详解相关推荐

最新文章

热门文章