狂神说Swagger:Swagger简介，Springboot集成swagger，其他皮肤

最新推荐文章于 2024-05-13 22:52:14 发布
最新推荐文章于 2024-05-13 22:52:14 发布
阅读量311 收藏 1
点赞数
分类专栏： Swagger 文章标签： spring boot 状态模式 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_56161114/article/details/132367399
版权

狂神说Swagger

学习目标

学习目标：

  • 了解Swagger的作用和概念
  • 了解前后端分离
  • 在SpringBoot中集成Swagger

Swagger简介

追溯历史

前后端分离：Vue+Springboot

后端时代：

前端只用管理静态页面，将整个html交给后端；后端的模板引擎JSP， 后端 是主力。

前后端分离时代：

  • 后端：后端控制层，服务层，数据访问层

  • 前端：前端控制层，视图层

    • 前端可以伪造后端的数据，通过json跟后端进行交互。现在已经不需要后端，前端工程依然可以运行起来。

  • 前后端交互方式：API接口

  • 前后端相对独立，松耦合

  • 前后端甚至可以部署到不同的服务器上面

产生的问题：

  • 前后端集成联调，前端人员和后端人员无法做到及时协商以便尽快解决问题，最终将导致问题集中爆发；简单来讲，也就是前端不知道后端将提供给前端的接口名字以及后端将传送给前端的数据以及数据类型。。

解决方案：

  • 首先应该指定计划，实时更新后端提供给前端的最新API，来降低集成的风险。

  • 比如早些年，会指定word计划文档

  • 前后端分离：

    • 前端测试后端的接口：postman

    • 后端提供接口，需要实时更新最新的消息以及改动

    • 不太方便：这样需要特定去下载安装postman

Swagger简介

在项目中使用swagger需要导入架包springbox

  • swagger2

  • ui

Springboot集成swagger

1.在IDEA里面新建一个sprongboot----web项目
1.打开IDEA，File–>New—>Project
在这里插入图片描述
若在此步出现如下错误：
在这里插入图片描述
解决方法为：先点击ok

方法1.然后点击下面指定位置进行刷新
在这里插入图片描述
方法2：若多次刷新没有效果，则放弃该次项目的创建，重建项目，本人亲测有效。

3.点击next
在这里插入图片描述
4.点击next后，选择一个纯springboot项目：如下
在这里插入图片描述
2.导入相关依赖：

 在pom.xml文件中导入依赖：
 <!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2-->
         <dependency>
             <groupId>io.springfox</groupId>
             <artifactId>springfox-swagger2</artifactId>
             <version>2.9.2</version>
         </dependency>
         <!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui-->
         <dependency>
             <groupId>io.springfox</groupId>
             <artifactId>springfox-swagger-ui</artifactId>
             <version>2.9.2</version>
         </dependency>

3.编写一个hello工程
1.在src–>main–>java—新建一个名为controller的包
在这里插入图片描述
2.在新建的包下面右键创建一个HelloController类,然后回车即可：
在这里插入图片描述
在这里插入图片描述
3.到文件HelloController类中，写入如下代码：

 package com.example.swagger.controller;
 ​
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 ​
 @RestController
 public class HelloController {
 ​
     @RequestMapping("/hello")
     public String hello(){
         return "hello";
     }
 }

4.到启动文件中（含有方法名为public static void main(String[] args)的文件中），按如下所示运行起来：
在这里插入图片描述
5.若在左下角的控制台下面如下图所示则运行成功：
在这里插入图片描述
6.打开浏览器输入网址：localhost:8080/hello,若出来下面的图，则运行正确：
在这里插入图片描述
4.配置swagger:
1.在pom.xml文件中加入以下依赖并及时从maven仓库中下载资源：

 在pom.xml文件中导入依赖：
 <!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2-->
         <dependency>
             <groupId>io.springfox</groupId>
             <artifactId>springfox-swagger2</artifactId>
             <version>2.9.2</version>
         </dependency>
         <!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui-->
         <dependency>
             <groupId>io.springfox</groupId>
             <artifactId>springfox-swagger-ui</artifactId>
             <version>2.9.2</version>
         </dependency>

2.创建与Controller同一级的包名为Config,并在改包下面创建类SwaggerConfig,最终文件展示如下：
在这里插入图片描述
3.在SwaggerConfig中加入如下内容：

 package com.example.swagger.config;
 ​
 import org.springframework.context.annotation.Configuration;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
 ​
 @Configuration
 @EnableSwagger2   //开启swagger2
 public class SwaggerConfig {
     
 }

4.运行，在启动文件中进行运行，一开始运行的时候报的错误为空指针异常，我也在网上试了很多方法，比如查看是不是端口号被占用，或者在pom.xml文件中更换springboot版本，或者在pom.xml文件中更换swagger版本，但是最终都没能够解决。随后，我直接将项目删除了，从头新建一个一摸一样的项目，并且按步骤先将springboot版本从2.6.4改为2.2.7并且将swagger的依赖加入到pom.xml文件中，最后进行一次性的maven加载资源包，才能够获取成功。

运行成功如下：
在这里插入图片描述
5.通过网址Swagger UI进行测试：出现如下图则成功：
在这里插入图片描述
4.配置swagger.config
Swagger有自己的一个bean实例Docket;

1.在文件SwaggerConfig中配置相关swagger的基本信息：

 package com.example.swaggerdemo.config;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 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;
 ​
 import java.util.ArrayList;
 ​
 import static springfox.documentation.service.ApiInfo.DEFAULT_CONTACT;
 ​
 @Configuration
 @EnableSwagger2   //开启swagger2
 public class SwaggerConfig {
 ​
     //配置了swagger的Docket的bean实例
     @Bean
     public Docket docket(){//该方法返回对象为Docket,并将该对象注入到Bean里面
         return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
     }
 ​
 ​
     //配置swagger的信息等于apiInfo
     private ApiInfo apiInfo(){
         //作者信息
         Contact contact = new Contact("刘艳","https://blog.kuangstudy.com/","2890850899@qq.com");
 ​
         return new ApiInfo(
                 "刘艳",//标题
                 "nihaoya",//描述
                 "v1.0",//版本
                 "https://blog.kuangstudy.com/",//组织名或者作者信息或者博客网址
                 DEFAULT_CONTACT,
                 "Apache 2.0",
                 "http:www.apache.org/licenses/LICENSE-2.0",
                 new ArrayList()
         );
     };
 }

2.重新运行该项目，运行成功后，进入网址Swagger UI测试如下图：
在这里插入图片描述
3.可以点开hello-controller知道如下，：
在这里插入图片描述
明明在此之前我们只有一个接口，但是会有那么多get ,post 等等路径，这是因为在我们的hellocontroller文件中只有一个@RequestMapping，，，并没有指明到底是getmapping还是postmapping或者其它方式。
在这里插入图片描述
5.Swagger配置扫描接口
1.配置扫描接口Docket.select()

    //配置了swagger的Docket的bean实例
     @Bean
     public Docket docket(){//该方法返回对象为Docket,并将该对象注入到Bean里面
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo())
                 .select()
                 //RequestHandlerSelectors配置要扫描接口的方式.
                 // basePackage()表示指定要扫描的包，参数为包的路径,一般会使用的方法
                 //any()表示扫描所有的包
                 //none()表示所有包都不扫描
                 //withClassAnnotation表示扫描类上面的注解，参数为一个注解的反射对象，值可以为：@GetMapping.class
                 //withMethodAnnotation表示扫描方法上面的注解
                 .apis(RequestHandlerSelectors.basePackage("com.example.swaggerdemo.controller"))
                 //path表示过滤,常用的为ant()
                 //.paths(PathSelectors.ant("/example/**"))
                 .build();
     }

在这里插入图片描述

上面代码中.apis(RequestHandlerSelectors.basePackage(“com.example.swaggerdemo.controller”))表示只扫描包com.example.swaggerdemo.controller，所以当我们打开网址Swagger UI可以看到只有一个接口信息：
在这里插入图片描述
2.配置是否启动swagger

    //enable为是否启动swagger，如果为false,则swagger不能在浏览器中访问
     @Bean
     public Docket docket(){//该方法返回对象为Docket,并将该对象注入到Bean里面
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo())
                 .enable(false)
                 .select()
    .apis(RequestHandlerSelectors.basePackage("com.example.swaggerdemo.controller"))
                 .build();
     }

配置完成后，重新运行项目，然后重新浏览swagger的网址，会出现下图所示：
在这里插入图片描述

问题：我只希望我的swagger在生产环境中使用，在发布的时候不使用？

  • 判断是不是生产环境 flag=false

  • 注入enable(flag)

进行多配置的方法:

1.第一套环境：在resources下面新建生产环境文件application-dev.properties 并输入以下内容：

 server.port=8081

2.第二套环境，在resources下面新建生产环境文件application-pro.properties 并输入以下内容：

server.port=8082

3.在文件SwaggerConfig中按如下设置：

 //配置了swagger的Docket的bean实例

   @Bean
   public Docket docket(Environment environment){//该方法返回对象为Docket,并将该对象注入到Bean里面

       //设置要显示的swagger环境
       Profiles profiles = Profiles.of("dev","test");

       //获取项目的环境：
       //通过environment.acceptsProfiles判断是否处在自己设定的环境中
       //如果系统检测到当前环境为dev或者test则flag为true,否则为flase
       boolean flag = environment.acceptsProfiles(profiles);


       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .enable(flag)
               .select()
               .apis(RequestHandlerSelectors.basePackage("com.example.swaggerdemo.controller"))
               .build();
   }\

4.重新运行swagger网址http://localhost:8080/swagger-ui.html，发现如下面所示：这是因为我们没有检测到当前环境，所以flag为flase
在这里插入图片描述
因此我们需要指定当前环境，步骤如下：

1.在resources下面的文件application.properties中输入以下代码，用来确定激活当前用哪一套环境：

spring.profiles.active=dev  
//指定当前环境为dev

2.然后再重新运行网址http://localhost:8081/swagger-ui.html，该网址的8080变为8081，是因为我们已经指定了当前环境为dev环境且该环境的端口号为8081。发现如下面所示：这是因为系统检测到当前环境为dev，所以flag为true：
在这里插入图片描述
注意：如果我们的swagger网址端口号为8080，将会出现如下错误：
在这里插入图片描述
6.配置API文档的分组
1.只有一个分组：在文件swaggerconfig.java中一定位置加入以下代码

 .groupName("zhangsan")//组名

运行项目后打开swagger网址为下图所示：
在这里插入图片描述
2.存在多个分组时，一个Docket对象代表一个祖，创建多个对象就会有多个组：文件swaggerconfig.java中代码如下：

//多个组
    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");//第一个组
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B");//第二个组
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");//第三个组
    }

运行项目后打开swagger网址为下图所示：
在这里插入图片描述

7.实体类配置
1.创建一个与controller包同等级的文件夹pojo，并在该文件下创建一个类User:
在这里插入图片描述
2.在实体类User中添加属性如下：

package com.example.swaggerdemo.pojo;
 
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
 
@ApiModel("用户实体类")//给实体类的文档注释
public class User {
 
    @ApiModelProperty("用户名")//给属性的文档注释
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

3.修改HelloController里面的内容如下：

package com.example.swaggerdemo.controller;
import com.example.swaggerdemo.pojo.User;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
 
@RestController
public class HelloController {
 
//    @RequestMapping("/hello")
//    public String hello(){
//        return "hello";
//    }
 
    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }
 
    //只要我们的接口中，返回值存在实体类，它就会被扫描到Swagger中
    @PostMapping("/user")
    public User user(){
        return new User();
    }
 
    //Operation接口,不是放在类上，而是放在方法
    @ApiOperation("hello控制类")
    @GetMapping("/hello2")
   public String hello2(@ApiParam("这是用户名") String username){//@ApiParam("用户名")为参数的注释
        return "hello"+username;
    }
}

4.运行项目后打开swagger网址为下图所示：
在这里插入图片描述
在这里插入图片描述
注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

总结：

  • 我们可以通过Swagger给一些比较难以理解的属性或者接口，增加注释信息

  • 接口文档实时更新

  • 可以在线测试

  • 是一个非常优秀的工具，几乎所有大公司都使用

  • 注意点：在正式发布的时候，关闭swagger.出于安全考虑，节省内存。

其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

1、默认的 访问 http://localhost:8080/swagger-ui.html

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

在这里插入图片描述
2、bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

在这里插入图片描述
3、Layui-ui 访问 http://localhost:8080/docs.html

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

在这里插入图片描述
4、mg-ui 访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

在这里插入图片描述

baiyi-123
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
给Swagger换个新皮肤
陪你听风的博客
07-23 1095
❝ knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。 ❞ 优点： 简洁：基于左右菜单式的布局方式,文档更清晰。 个性化配置：支持接口地址、接口description属性、UI增强等个性化配置功能。 增强：接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能。 官方文档地址：https://doc.xiaominfo.com/ 在线演示地址：http:/...
Swagger.md，听的是b站狂神说的swagger教学
10-24
看狂神说的b站swagger视频，typroa笔记，超级详细
狂神swagger
qq_40813329的博客
12-14 346
前后端分离必备工具：Swagger快速搞定(整合SpringBoot详细教程) 【狂神说Java】一小时掌握Swagger技术
最全给Swagger换了个新皮肤，瞬间高大上了！，写给互联网大厂员工的真心话
最新发布
2401_83977705的博客
05-13 676
切莫死记硬背，小心面试官直接让你出门右拐1000道互联网Java面试题：
发现Swagger的新皮肤 Knife4j
lyn1032的博客
12-04 354
先上效果图： . Swagger作为一款API文档生成工具，虽然功能已经很完善了，但是还是有些不足的地方。偶然发现knife4j弥补了这些不足，赋予了Swagger更多的功能，今天我们来讲下它的使用方法。 knife4j简介 knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。knife4j完全遵循了springfox-swagger中的使用方式，并在此基础上做了增强功能，如果你用过Swagger，你就可以无缝切换到k
b站狂神Swagger学习笔记
abc98526的博客
06-15 260
Vue+SpringBoot 后端时代:前端只用管理静态页面;html==>后台.模板引擎JSP=>后端是主力 前后端分离时代:#Swagger1.编写一个SpringBoot的web项目 2.在项目中导入Swagger相关依赖 3.编写一个Hello工程 4.因为swagger是单独的所以需要我们进行配置 因为Swagger是一个单独的包并没有被整合! 5.进行测试访问http://localhost:8080/swagger-ui.html [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来
Swagger（狂神说Java）（教学视频+源代码）
02-03
Swagger（狂神说Java） 一、学习目标： 二、Swagger简介 三、SpringBoot集成Swagger 3.1.新建一个SpringBoot的web项目 3.2.导入相关依赖 3.3编写一个Hello工程 3.4 配置Swagger==>Config 3.5.测试运行，访问`...
springboot集成swagger
02-22
在本文中，我们将深入探讨如何将Swagger UI与Spring Boot项目集成，以便轻松地实现API的文档化和测试。首先，我们需要了解所涉及的关键技术：Spring Boot、Swagger UI、Maven以及IDEA。 **Spring Boot** Spring ...
狂神笔记，b站狂神说课程笔记大全(最新)
09-19
b站狂神说课程笔记大全，每个部分都有 狂神说java系列笔记（java基础+javaweb+ssm+微服务）全套 狂神说上课笔记未删减 Java基础到技术升级 1、JavaSE：Java入门 2、JavaSE：基础语法 3、JavaSE：流程控制 4、JavaSE...
狂神SpringBoot源码--分享
04-30
《狂神SpringBoot源码深度解析与实践》 SpringBoot是由Pivotal团队开发的一款用于简化Spring应用初始搭建以及开发过程的框架。它基于Spring框架，致力于“开箱即用”和“零配置”，旨在让开发者能快速创建稳定、...
[Swagger2]拓展：其他皮肤
m0_51955470的博客
03-06 255
拓展：其他皮肤 我们可以导入不同的包实现不同的皮肤定义： 1、默认的 访问 http://localhost:8080/swagger-ui.html <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </depend
换一个swagger的前端皮肤
绅士jiejie的博客
11-23 447
原来的swagger的前端皮肤展示如下： 其实感觉也还好，但是如果控制器类多了，那审美就会有点疲劳了，所以可以试着换一换swagger的前端皮肤，换成一种更符合我们操作习惯的前端皮肤。 怎么换？可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui。 这里就用swagger-bootstrap-ui的最后一个版本1.9.6来做演示，依赖如下： <dependency> <groupId>com.gith
2024年最新狂神Swagger笔记(Swagger轻松入门)，java高级工程师面试
2401_84692538的博客
05-09 521
手绘了下图所示的kafka知识大纲流程图（xmind文件不能上传，导出图片展现），但都可提供源文件给每位爱学习的朋友本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录需要这份系统化的资料的朋友，可以点击这里获取二、SpringBoot集成Swagger1.引入库2.导入依赖3.配置Swagger4.进入测试Swagger配置扫描接口配置是否启动Swagger配置API文档分组实体类的配置文档注解总结前言说起Swagger就不得不说前后端分离。
最详细狂神swagger学习笔记
weixin_57259781的博客
03-15 1225
最详细狂神swagger学习笔记
给Swagger换了个新皮肤，瞬间高大上了！
macrozheng的专栏
07-21 2185
Swagger作为一款API文档生成工具，虽然功能已经很完善了，但是还是有些不足的地方。偶然发现knife4j弥补了这些不足，赋予了Swagger更多的功能，今天我们来讲下它的使用方法。...
给Swagger换了个新皮肤，瞬间高大上了
weixin_47083537的博客
07-21 930
Swagger作为一款API文档生成工具，虽然功能已经很完善了，但是还是有些不足的地方。偶然发现knife4j弥补了这些不足，赋予了Swagger更多的功能，今天我们来讲下它的使用方法。 knife4j简介 knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。knife4j完全遵循了springfox-swagger中的使用方式，并在此基础上做了增强功能，如果你用过Swagger，你就可以无缝切换到knife4j。.
swagger的使用
qq_45260619的博客
03-25 476
Swagger 狂神SpringBoot第P50有讲解 号称世界上最流行的Api框架 RestFul Api文档在线自动生成工具=>Api文档与Api定义同步更新 直接运行，可以在线测试API接口 支持多种语言（Java，Php…） SpringBoot集成Swagger 新建一个 Spring - Web项目 导入依赖 Springfox Swagger2 Springfox Sw...
前后端分离，Swagger框架
smileLs的博客
03-13 1121
前后端分离，Swagger框架 1.简介 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架，而且swagger可以完全模拟http请求，入参出参和实际情况...
Swagger框架
weixin_63738525的博客
03-22 1789
Swagger框架
狂神说Docker笔记，详细上课笔记
02-20
狂神说Docker笔记是一份详细的上课笔记，涵盖了Docker的基本概念和原理。Docker作为一款正在流行的容器化技术，为解决开发和运维人员之间的协作问题提供了便利。在过去，为了确保软件在不同环境中的兼容性，运维人员...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值