SpringBoot-06-Swagger

最新推荐文章于 2024-07-13 11:30:35 发布
最新推荐文章于 2024-07-13 11:30:35 发布
阅读量221 收藏
点赞数
分类专栏： SpringBoot 文章标签： spring boot java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46147113/article/details/123179668
版权

一、集成

 

①环境依赖

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

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

②简单测试

package com.gg.controller;


import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class Hello {
    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }
}

package com.gg.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

}

③访问页面

http://localhost:8080/swagger-ui.html#/

 二、配置

①配置swagger信息

package com.gg.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

    //  配置swagger的docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    //配置swagger信息=apiInfo

    private ApiInfo apiInfo(){
        Contact contact=new Contact("阿国","测试网址","1111@qq.com");
        return new ApiInfo(
                "学习用1",
                "学习用2",
                "学习用3",
                "学习用4",
                contact,
                "学习用5",
                "学习用6",
                new ArrayList()
        );
    }

}

②配置接口信息

.apiInfo(apiInfo对象)

package com.gg.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

    //  配置swagger的docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //  RequestHandlerSelectors：配置要扫描的接口方式
                //  basePackage：指定要扫描的包
                //  any()：扫描全部
                //  none()：不扫描
                //  withClassAnnotation：扫描类上的注解，参数是一个注解的反射对象
                //  withMethodAnnotation：扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.gg.controller"))
                //  paths()：过滤什么路径
                .paths(PathSelectors.ant("/gg/**"))
                .build()
                ;
    }
    //配置swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact=new Contact("阿国","测试网址","1111@qq.com");
        return new ApiInfo(
                "学习用1",
                "学习用2",
                "学习用3",
                "学习用4",
                contact,
                "学习用5",
                "学习用6",
                new ArrayList()
        );
    }

}

 ③配置是否启动

.enable(true   ||   false)

package com.gg.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

    //  配置swagger的docket的bean实例
    //  enable():如果为false
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false)
                .select()
                //  paths()：过滤什么路径
                //.paths(PathSelectors.ant("/gg/**"))
                .build()
                ;
    }
    //配置swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact=new Contact("阿国","测试网址","1111@qq.com");
        return new ApiInfo(
                "学习用1",
                "学习用2",
                "学习用3",
                "学习用4",
                contact,
                "学习用5",
                "学习用6",
                new ArrayList()
        );
    }

}

 ④配置分组

.groupName(分组名)

package com.gg.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 springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

    //  配置swagger的docket的bean实例
    //  enable():如果为false则关闭
    @Bean
    public Docket docket(Environment environment){

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


        //  通过environment.acceptsProfiles判断是否处于自己设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("阿国")
                .enable(flag)  //  enable是否启动swagger
                .select()
                //  paths()：过滤什么路径
                //.paths(PathSelectors.ant("/gg/**"))
                .apis(RequestHandlerSelectors.basePackage("com.gg.controller"))
                .build()
                ;
    }
    //配置swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact=new Contact("阿国","测试网址","1111@qq.com");
        return new ApiInfo(
                "学习用1",
                "学习用2",
                "学习用3",
                "学习用4",
                contact,
                "学习用5",
                "学习用6",
                new ArrayList()
        );
    }

}

 配置多个分组

package com.gg.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 springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

    // 配置多个分组
    @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的docket的bean实例
    //  enable():如果为false则关闭
    @Bean
    public Docket docket(Environment environment){

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


        //  通过environment.acceptsProfiles判断是否处于自己设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("阿国")
                .enable(flag)  //  enable是否启动swagger
                .select()
                //  paths()：过滤什么路径
                //.paths(PathSelectors.ant("/gg/**"))
                .apis(RequestHandlerSelectors.basePackage("com.gg.controller"))
                .build()
                ;
    }
    //配置swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact=new Contact("阿国","测试网址","1111@qq.com");
        return new ApiInfo(
                "学习用1",
                "学习用2",
                "学习用3",
                "学习用4",
                contact,
                "学习用5",
                "学习用6",
                new ArrayList()
        );
    }

}

 

三、在生产环境中使用，在发布时不使用

①properties文件配置

端口号分别为：8080、8081、8082

② 获取选定的环境

package com.gg.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 springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

@Configuration  //标记为配置类
@EnableSwagger2 //启动swagger
public class SwaggerConfig {

    //  配置swagger的docket的bean实例
    //  enable():如果为false则关闭
    @Bean
    public Docket docket(Environment environment){

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


        //  通过environment.acceptsProfiles判断是否处于自己设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(flag)  //  enable是否启动swagger
                .select()
                //  paths()：过滤什么路径
                //.paths(PathSelectors.ant("/gg/**"))
                .apis(RequestHandlerSelectors.basePackage("com.gg.controller"))
                .build()
                ;
    }
    //配置swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact=new Contact("阿国","测试网址","1111@qq.com");
        return new ApiInfo(
                "学习用1",
                "学习用2",
                "学习用3",
                "学习用4",
                contact,
                "学习用5",
                "学习用6",
                new ArrayList()
        );
    }

}

 四、实体类和接口配置

pojo实体类对象

package com.gg.pojo;

public class User {
    public String  username;
    public String  password;
}

 

 

package com.gg.pojo;


import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel("用户实体类")  //  相当于给实体类注释
public class User {
    
    @ApiModelProperty("用户名")    //  给变量表注释
    public String  username;
    @ApiModelProperty("密码")
    public String  password;
}

 接口配置

package com.gg.controller;


import com.gg.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 Hello {
    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }

    //  只要接口中，返回值中存在实体类，就会被扫描的swagger
    @PostMapping("/user")
    public User user(){
        return new User();
    }

   

}

 接口类注释

package com.gg.controller;


import com.gg.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 Hello {
    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }

    //  只要接口中，返回值中存在实体类，就会被扫描的swagger
    @PostMapping("/user")
    public User user(){
        return new User();
    }

    @ApiOperation("hello控制类")
    @GetMapping("/hello2")
    public String hello2(String username){
        return "hello"+username;
    }

}

 接口参数api注释

 

 

阿国GG在学习
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot--Swagger依赖
java_freshman_的博客
01-27 1188
依赖说明： <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> ...
SpringBoot快速入门6---Swagger、任务及初识分布式
Done++的博客
06-08 255
文章目录Swagger简介在项目中使用SwaggerSpringBoot集成Swagger配置Swagger分组和接口注释Swagger使用测试功能任务异步任务定时任务邮件发送分布式理论什么是分布式系统单一应用架构垂直应用架构分布式服务架构流动计算架构什么是RPCRPC基本原理步骤解析 Swagger 简介 典型前后端分离：Vue + SpringBoot 后端时代：前端只用管理静态页面，html ==> 后端，模板引擎 jsp ==> 后端是主力 前后端分离时代： 后端：后端控制
解决Spring Boot 6.x 与Swagger 3.0.0 不兼容问题
evalsys的博客
03-06 631
解决Spring Boot 6.x 与Swagger 3.0.0 不兼容问题
Java：SpringBoot系列——第六章 整合Swagger
chenyouchang的博客
01-12 1961
SpringBoot应用集成Swagger的步骤，用于生成接口规范文档和接口测试
Spring Boot 中如何使用 Swagger
徐师兄的博客
06-26 1846
本文介绍了如何在 Spring Boot 应用中使用 Swagger，包括引入依赖、配置 Swagger、使用 Swagger 注解和使用 Swagger UI 界面。Swagger 可以帮助开发者快速生成 API 文档，并提供一系列的交互式工具，方便开发者进行 API 的调试和测试。
接口文档配置
m0_58269982的博客
11-17 534
配置接口文档
springboot-swagger-demo202010221424.zip
10-22
本文将详细讲解如何在SpringBoot项目中集成Swagger，以"springboot-swagger-demo202010221424.zip"为例，揭示其中的技术细节。 首先，我们需要了解SpringBoot和Swagger的基础知识。SpringBoot是Spring框架的一种...
Springboot-Jersey-Swagger
05-01
如何配置Spring Boot Jersey和Swagger 问题陈述 如何集成Spring Boot，Jersey，Swagger来构建基于JSON的真实世界的RESTful Web服务 在开始之前 我们必须将Spring Boot Starter Web作为Swagger UI的依赖项才能正常...
springboot-swagger.zip
12-26
最后，通过访问`http://localhost:8080/swagger-ui/`（假设你的应用运行在8080端口）即可查看生成的Swagger UI界面，进行API的浏览和测试。 总结来说，SpringBoot整合Swagger2主要涉及以下几个步骤：引入依赖、启用...
SpringBoot-swagger-logging
03-13
本项目"SpringBoot-swagger-logging"结合了这三个工具，旨在创建一个具备API文档化和日志管理功能的微服务应用。 首先，SpringBoot是基于Spring框架的轻量级开发工具，它简化了Spring应用程序的配置和启动过程。...
111-springboot-demo-swagger-v3-openapi.rar
03-07
什么是Swagger？Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。从上述 Swagger 定义我们...
10 万字节Spring Boot +redis详细面试笔记(带完整目录)全新开源
2401_84102400的博客
04-13 390
本文从基础到高级再到实战，由浅入深，把MySQL讲的清清楚楚，明明白白，这应该是我目前为止看到过最好的有关MySQL的学习笔记了，我相信如果你把这份笔记认真看完后，无论是工作中碰到的问题还是被面试官问到的问题都能迎刃而解！MySQL50道高频面试题整理：网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注Java）一个人可以走的很快，但一群人才能走的更远！
SpringBoot集成Swagger终极版
不言而喻i的博客
06-03 6820
学习目标： 了解Swagger的概念及作用 掌握在项目中集成Swagger自动生成API文档 Swagger简介 前后端分离 前端 -> 前端控制层、视图层 后端 -> 后端控制层、服务层、数据访问层 前后端通过API进行交互 前后端相对独立且松耦合 产生的问题 前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发 解决方案 首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险 Swagger 号称世界上最流行的API框.
狂神说Swagger笔记
weixin_44202871的博客
04-06 2125
项目集成Swagger 学习目标： 了解Swagger的概念及作用 掌握在项目中集成Swagger自动生成API文档 Swagger简介 前后端分离 前端 -> 前端控制层、视图层 后端 -> 后端控制层、服务层、数据访问层 前后端通过API进行交互 前后端相对独立且松耦合 产生的问题 前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发 解决方案 首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险 Swagger 号称
Spring Boot中的多租户架构实现
微赚淘客开发者博客
07-06 1428
在多租户系统中，每个租户都能够安全且有效地使用相同的应用程序，同时确保数据隔离和性能独立性。通过合理的设计和实施，开发人员可以有效地管理和运行支持多个租户的应用程序，从而提升系统的灵活性和扩展性。每个租户是一个逻辑上独立的客户，拥有自己的数据、配置、用户界面等资源，而这些资源又可以在同一个应用程序实例中共享。在Spring Boot中配置多租户数据源，可以使用AbstractRoutingDataSource实现动态数据源切换，根据不同的租户标识动态选择数据源。
项目实战--Spring Boot + GraphQL实现实时数据推送
qq_40623672的博客
07-10 459
GraphQL是一种用于API的查询语言，核心思想是让客户端能够根据自身需求精确地获取所需的数据，而不是像传统的RESTful API那样只能获取整个资源对象。（1）灵活性：客户端可以精确指定所需的数据字段，而不是被限制于服务器端提供的固定数据结构。（2）效率：减少了不必要的数据传输和处理，提高了数据获取效率。（3）类型系统：GraphQL具有严格的类型系统，能够在编译阶段检测出潜在的错误，提高了开发效率。
Spring Boot集成pf4j实现插件开发功能
HBLOG
07-10 566
一个插件框架，用于实现插件的动态加载，支持的插件格式（zip、jar）。
Spring Boot单体服务之间用feign调用
木槿
07-09 163
会定义路径和url等信息，用于指定服务调用服务调用启动feign配置调用url。
Spring Boot中的 6 种API请求参数读取方式
最新发布
恒安软件
07-13 142
使用Spring Boot开发API的时候，读取请求参数是服务端编码中最基本的一项操作，Spring Boot中也提供了多种机制来满足不同的API设计要求。接下来，就通过本文，为大家总结6种常用的请求参数读取方式。如果你发现自己知道的不到6种，那么赶紧来查漏补缺一下。如果你知道的不止6种，那么告诉大家，一起互相学习一下吧～
springboot-plus
05-31
SpringBoot-Plus是一个基于SpringBoot的快速开发框架，它集成了一系列常用的功能和组件，如MyBatis-Plus、Shiro、Swagger等，可以帮助开发者快速构建高质量、可维护的Web应用程序。SpringBoot-Plus提供了一些基础的代码和配置，使得开发者可以专注于业务逻辑的实现，而不必再花费时间和精力去搭建项目框架和集成各种组件。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值