013springboot--Swagger

已于 2022-02-16 22:43:57 修改
阅读量443 收藏
点赞数
分类专栏： SpringBoot 文章标签： java spring boot elementui
于 2022-02-13 23:04:26 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gh_xiaohe/article/details/122906891
版权

目录

swagger入门

导入依赖

配置swagger--->Config

测试：http://localhost:8080/swagger-ui.html

配置Swagger

源码：

 代码：

配置扫描接口

        接口过滤

 配置是都启动Swagger

 问题： 希望Swagger 在生产环境中使用,在发布的时候不使用？

 配置Api文档分组

 问题：如何配置多个组    多个Docket实例即可

实体类配置 

user

HelloController   

 目录：

SwaggerConfig

HelloController

User

总结：

swagger入门

导入依赖

        <!-- 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>

配置swagger--->Config

@Configuration
@EnableSwagger2     //开启Swagger2的自动装配
public class SwaggerConfig {

}

测试：http://localhost:8080/swagger-ui.html

配置Swagger

Swagger的bean实例Docket

源码：

    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    //配置Swagger2的apiInfo信息
    private ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact("gh", "https://blog.csdn.net/gh_xiaohe?spm=1000.2115.3001.5343", "2495140780@qq.com");
        return new ApiInfo(
                "Swagger2 API文档",    //标题
                "文档描述写啥我也不知道!!!",       //描述
                "V1.0",                             //版本信息
                "localhost:8080/hello",     //组织链接
                contact,                                    //联系人信息
                "Apache 2.0",                       //许可
                "http://www.apache.org/licenses/LICENSE-2.0",   //许可连接
                new ArrayList()                //扩展
        );
    }

 代码：

    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }
    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    //配置Swagger2的apiInfo信息
    private ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact(
                "gh",
                "https://blog.csdn.net/gh_xiaohe",
                "2495140780@qq.com");
        return new ApiInfo(
                "Swagger2 API文档",    //标题
                "文档描述写啥我也不知道!!!",       //描述
                "V1.0",                             //版本信息
                "https://www.bilibili.com/",    //组织链接
                contact,                                    //联系人信息
                "Apache 2.0",                       //许可
                "http://www.apache.org/licenses/LICENSE-2.0", //许可连接
                new ArrayList()                //扩展
        );
    }

配置扫描接口

        接口过滤

Docket.select()

    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()

                
                .build();

    }
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()

                 /*
               只有两个选项 .apis()  .paths
                    拉姆达表达式  是个接口  使用实现类
                    RequestHandlerSelectors  配置要扫描接口的方式
                       basePackage：根据包扫描接口
                       any()：扫描所有 项目中所有的接口都会被扫描
                       none()：都不扫描
                       withClassAnnotation()：根据类上的注解进行扫描
                       withMethodAnnotation()：根据方法上的注解进行扫描
              */
                .apis(RequestHandlerSelectors.basePackage("com.gh.controller"))


                .build();


    }

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()

                 /*
               只有两个选项 .apis()  .paths
                    拉姆达表达式  是个接口  使用实现类
                    RequestHandlerSelectors  配置要扫描接口的方式
                       basePackage：根据包扫描接口
                       any()：扫描所有 项目中所有的接口都会被扫描
                       none()：都不扫描
                       withClassAnnotation()：根据类上的注解进行扫描    传入 注解的反射对象
                       withMethodAnnotation()：根据方法上的注解进行扫描  withClassAnnotation(GetMapping.class))
              */
                .apis(RequestHandlerSelectors.basePackage("com.gh.controller"))
                //过滤  过滤什么路径
                .paths(PathSelectors.ant("/gh/**"))  //扫描这个包，并且 只扫描带有 gh 这个请求的接口

                .build();


    }

 配置是都启动Swagger

//enable 是否启动 Swagger 如果为false 则 Swagger 不能在浏览器访问
.enable(false)  //默认true
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //enable 是否启动 Swagger 如果为false 则 Swagger 不能在浏览器访问
                .enable(false) //默认true
                .select()

                 /*
               只有两个选项 .apis()  .paths
                    拉姆达表达式  是个接口  使用实现类
                    RequestHandlerSelectors  配置要扫描接口的方式
                       basePackage：根据包扫描接口
                       any()：扫描所有 项目中所有的接口都会被扫描
                       none()：都不扫描
                       withClassAnnotation()：根据类上的注解进行扫描    传入 注解的反射对象
                       withMethodAnnotation()：根据方法上的注解进行扫描  withClassAnnotation(GetMapping.class))
              */
                .apis(RequestHandlerSelectors.basePackage("com.gh.controller"))
                //过滤  过滤什么路径
//                .paths(PathSelectors.ant("/gh/**"))  //扫描这个包，并且 只扫描带有 gh 这个请求的接口
                .build();


    }

 

 问题： 希望Swagger 在生产环境中使用,在发布的时候不使用？

  • 判断是不是生产环境  flag = false
  • 注入enable （flag）

application.properties

        spring.profiles.active=dev

application-dev.properties

       server.port=8081

application-pro.properties

        server.port=8082

    @Bean
    public Docket docket(Environment environment) {

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

        //获取项目的环境
        //通过environment.acceptsProfiles 来判断是否处在自己设定的环境当中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //enable 是否启动 Swagger 如果为false 则 Swagger 不能在浏览器访问
                .enable(flag)  //默认true
                .select()

                 /*
               只有两个选项 .apis()  .paths
                    拉姆达表达式  是个接口  使用实现类
                    RequestHandlerSelectors  配置要扫描接口的方式
                       basePackage：根据包扫描接口
                       any()：扫描所有 项目中所有的接口都会被扫描
                       none()：都不扫描
                       withClassAnnotation()：根据类上的注解进行扫描    传入 注解的反射对象
                       withMethodAnnotation()：根据方法上的注解进行扫描  withClassAnnotation(GetMapping.class))
              */
                .apis(RequestHandlerSelectors.basePackage("com.gh.controller"))
                //过滤  过滤什么路径
//                .paths(PathSelectors.ant("/gh/**"))  //扫描这个包，并且 只扫描带有 gh 这个请求的接口
                .build();


    }

 

 配置Api文档分组

.groupName("Hello-Swagger")

 

 问题：如何配置多个组    多个Docket实例即可

    /**
     *  配置多个分组 只需往往容器里多注入几个Docket的bean
     */

    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("AAA");
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("BBB");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("CCC");
    }

 

实体类配置 

@ApiModel

@ApiModelProperty

@Api(tags = "用户控制")

@ApiOperation("Hello控制类")    //Operation 接口  不是放在类上，是方法

@ApiParam 方法形参 

 

 

 

user

//给生成的文档加一个注释
@Api(注释)
@ApiModel("User:用户实体类")
public class User {

    @ApiModelProperty("用户名")
    public String username;

    @ApiModelProperty("密码")
    public String password;
}

HelloController   

                只和 返回值 中  有无实体类有关 和有无注解无关

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "Hello,Swagger";
    }

    //只要我们的接口中,返回值中存在实体类,他就会被扫描到 Swagger 中
    @GetMapping("/user")
    public User user1(){
        return new User();
    }
}


    //Operation 接口 不是放在类上，是方法
    @ApiOperation("Hello控制类")
    @PostMapping("/hello2")
    public String hello2(@ApiParam("用户名") String name){
        return name;
    }

 

 目录：

SwaggerConfig

package com.gh.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.bind.annotation.GetMapping;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.VendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2     //开启Swagger2的自动装配
public class SwaggerConfig {



    @Bean
    public Docket docket(Environment environment) {

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

        //获取项目的环境
        //通过environment.acceptsProfiles 来判断是否处在自己设定的环境当中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("Hello-Swagger")
                //enable 是否启动 Swagger 如果为false 则 Swagger 不能在浏览器访问
                .enable(flag)  //默认true
                .select()

                 /*
               只有两个选项 .apis()  .paths
                    拉姆达表达式  是个接口  使用实现类
                    RequestHandlerSelectors  配置要扫描接口的方式
                       basePackage：根据包扫描接口
                       any()：扫描所有 项目中所有的接口都会被扫描
                       none()：都不扫描
                       withClassAnnotation()：根据类上的注解进行扫描    传入 注解的反射对象
                       withMethodAnnotation()：根据方法上的注解进行扫描  withClassAnnotation(GetMapping.class))
              */
                .apis(RequestHandlerSelectors.basePackage("com.gh.controller"))
                //过滤  过滤什么路径
//                .paths(PathSelectors.ant("/gh/**"))  //扫描这个包，并且 只扫描带有 gh 这个请求的接口
                .build();

    }

    

    //配置Swagger2的apiInfo信息
    private ApiInfo apiInfo() {
        //作者信息
        Contact contact = new Contact(
                "gh",
                "https://blog.csdn.net/gh_xiaohe",
                "2495140780@qq.com");
        return new ApiInfo(
                "Swagger2 API文档",    //标题
                "文档描述写啥我也不知道!!!",       //描述
                "V1.0",                             //版本信息
                "https://www.bilibili.com/",    //组织链接
                contact,                                    //联系人信息
                "Apache 2.0",                       //许可
                "http://www.apache.org/licenses/LICENSE-2.0", //许可连接
                new ArrayList()                //扩展
        );
    }

//    private ApiInfo apiInfo() {
//        return new ApiInfo(
//               "Api Documentation",
//                "Api Documentation",
//                "1.0",
//                "urn:tos",
//                DEFAULT_CONTACT,
//                "Apache 2.0",
//                "http://www.apache.org/licenses/LICENSE-2.0",
//                new ArrayList());
//    }


    /**
     *  配置多个分组 只需往往容器里多注入几个Docket的bean
     */

    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("AAA");
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("BBB");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("CCC");
    }

}

HelloController

package com.gh.controller;

import com.gh.pojo.User;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello(){
        return "Hello,Swagger";
    }

    //只要我们的接口中,返回值中存在实体类,他就会被扫描到 Swagger 中
    @GetMapping("/user")
    public User user(){
        return new User();
    }

    //Operation 接口 不是放在类上，是方法
    @ApiOperation("Hello控制类")
    @GetMapping("/hello2")
    public String hello2(@ApiParam("用户名") String name){
        return name;
    }

    @ApiOperation("post")
    @PostMapping("/post")
    public User post(@ApiParam("用户名") User user){
        return user;
    }
}

User

//给生成的文档加一个注释
//@Api(注释)
@ApiModel("User:用户实体类")
public class User {

    @ApiModelProperty("用户名")
    public String username;

    @ApiModelProperty("密码")
    public String password;
}

总结：

  1. 我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息
  2. 接口文档实时更新
  3. 可以在线测试

【注意点】在正式发布的时候，关闭Swagger！！！出于安全考虑。而且节省运行的内存；

gh-xiaohe
关注
专栏目录
【二十一】springboot整合过滤器实战
weixin_56995925的博客
04-11 3338
springboot整合过滤器实战
springboot定义过滤器放行swagger遇到的问题
Curtisjia的博客
04-22 2610
最近在项目里加了个过滤器，拦截请求的token，但是我想放行swagger的页面，我在过滤器里配置了放行规则但是swagger出现Unable to infer base url。 百度了一下有以下几种可能： 需要在SpringBoot的启动Application前面加上 @EnableSwagger2注解； 可能是由于使用了Spring Security 影响； 在排查该问题时，假设你的swagger-ui访问路径是http://localhost:8080/swagger-ui.html，可以先直接访
【SpringBoot】跨域、过滤器及swaggerUI配置
香草天空Sky的博客
07-25 1236
1. springbootWebAppConfig配置 /** * Created with IntelliJ IDEA. * * @author: zhangenke @Date: 2018/8/16 on 下午2:25 * @description: 让 springBoot 知道有这个拦截器 */ @Slf4j @Configuration public class WebA...
swagger文档屏蔽字段、swagger忽略字段
最新发布
木辰風的博客
08-01 318
@ApiModelProperty 注解增加 hidden = true。如果想不展示这个字段 用 这个注解。 @JsonIgnore 如果想不展示这个字段 用 这个注解
springboot跨域过滤器与swagger拦截器冲突的解决方案
lsqingfeng的博客
12-02 4513
最近在做一个项目，有这样的使用场景，首先是前后端分离，联调的时候出现了跨域问题。所以添加了一个处理跨域的拦截器。代码如下： @Order(1) @Component @WebFilter(urlPatterns = "/*", filterName = "cooCorsFilter") public class CooCorsFilter implements Filter { String ORIGIN = "Origin"; @Override public void i
Swagger Api工具
Student111w的博客
05-02 1187
Swagger简介 前后端分离 vue+springboot 后端时代 前端只管理静态页面 html==》后端 模板引擎 jsp==》后端是主力 前后端分离时代 后端：后端控制层，服务层 ，数据访问层[后端团队] 前端：前端控制层，视图层[前端团队] 伪造后端数据 ，json。已经存在了 不需要后端，前端工程依旧能跑起来了 前后端如何交互==>API接口 前后端相互独立，松耦合。 前后端甚至可以部署在不同的服务器上 产生一个问题： 前后端集成联调，前端人员和后端人员无法做到及时协商，尽早解决。 解决
springboot-swagger-demo202010221424.zip
10-22
本文将详细讲解如何在SpringBoot项目中集成Swagger，以"springboot-swagger-demo202010221424.zip"为例，揭示其中的技术细节。 首先，我们需要了解SpringBoot和Swagger的基础知识。SpringBoot是Spring框架的一种...
111-springboot-demo-swagger-v3-openapi.rar
03-07
什么是Swagger？Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。从上述 Swagger 定义我们...
Springboot-Jersey-Swagger
05-01
如何配置Spring Boot Jersey和Swagger 问题陈述 如何集成Spring Boot，Jersey，Swagger来构建基于JSON的真实世界的RESTful Web服务 在开始之前 我们必须将Spring Boot Starter Web作为Swagger UI的依赖项才能正常...
111-springboot-demo-swagger-v2-bootstrap-ui.rar
03-07
什么是Swagger？Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。从上述 Swagger 定义我们...
111-springboot-demo-swagger-v2.rar
03-07
SpringBoot接口 - 如何生成接口文档之Swagger技术栈准备知识点什么是OpenAPI规范（OAS)？什么是Swagger？Swagger和SpringFox有啥关系？什么是Knife4J? 和Swagger什么关系？实现案例之Swagger3POMSwagger Config...
spring boot集成swagger之springfox-boot-starter配置指定apis()（三）
何虎军
05-24 868
1、说明 网上之前的资料大多是基于guava中predicates/functions实现的 本文将采用java8实现 前情提要 官网说明 Springfox 3.x removes dependencies on guava and other 3rd party libraries (not zero dep yet! depends on spring plugin and open api libraries for annotations and models) so if you used g
Swagger配置扫描路径和过滤URL
CSDN_Ty的博客
08-11 2061
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ParameterBuilder; import springfox.documentat..
swagger根据注解屏蔽大量不需要的接口
有情怀的程序员的博客
03-29 5417
公司一些老项目里加入了swagger，由于项目太大，接口巨多，扫描的无用的接口信息很恶心，用包路径区分的方式解决不了旧的controller上也有文档注解的问题。 偶然发现扫描api路径的时候可以选择只扫描带注解的，这个很实用，具体例子如下： return new Docket(DocumentationType.SWAGGER_2) .select() ...
Swagger简单使用
qq_45917176的博客
09-18 769
Swagger/Knife4j简单使用
Swagger--配置扫描接口及开关
天行健 君子以自强不息，地势坤 君子以厚德载物。
06-06 1736
1. Swagger–配置扫描接口及开关
swagger过滤controller
zhou1124的博客
12-30 2349
需求只保留有@ApiOperation的注解方法，声明一个类实现 Predicate，里面也可以添加自定义的逻辑。 @Bean public Docket createAPI() { return new Docket(DocumentationType.SWAGGER_2).forCodeGeneration(true).select().apis(RequestHan...
后端 API 接口文档 Swagger 使用指南
油墨香^-^的博客
08-27 3023
springboot整合swagger，只需要添加一个swagger的配置类，添加上@bean注解，就可以实现Bean的注入，然后添加一个ApiInfo的配置，添加注解扫描，其实对于扫描这里，配置分类两类，一个是包的路径扫描，一个是按照注解的扫描，我比价推荐的方式是按照注解，因为在swageer的实际使用中，你得在每个api中添加@APi的注解，但是如果配置成包的话，有可能会有遗漏，或者新增加包路径可能忘了配置，就导致配置无效。并且有一个很重要的功能，只需要点下方的try it out就可以进行接口测试，.
[Swagger2]Swaggr配置扫描接口&&配置Swagger开关
m0_51955470的博客
03-06 1691
Swagger配置扫描接口 1、构建Docket时通过select()方法配置怎么扫描接口。 @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口 .apis(RequestHandlerSele
springboot-plus
05-31
SpringBoot-Plus是一个基于SpringBoot的快速开发框架，它集成了一系列常用的功能和组件，如MyBatis-Plus、Shiro、Swagger等，可以帮助开发者快速构建高质量、可维护的Web应用程序。SpringBoot-Plus提供了一些基础的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

gh-xiaohe

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值