Swagger 3(1)

最新推荐文章于 2024-05-20 09:49:17 发布
最新推荐文章于 2024-05-20 09:49:17 发布
阅读量884 收藏 26
点赞数 21
分类专栏： 程序员 文章标签： java 面试 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84091544/article/details/138432246
版权

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
“http://www.apache.org/licenses/LICENSE-2.0”,

new ArrayList());

}

}

在这里插入图片描述

配置Swagger自定义扫描接口

我们在这个ui界面中，可以看到扫描了两个controller接口；

在这里插入图片描述

  • 一个是默认的/error请求，也就是我们启动springboot主程序未加配置默认访问8080端口的默认controller

在这里插入图片描述

  • 剩余的就是我们自己再controller层写的请求映射了

自定义扫描接口

//配置Swagger的Docket的bean实例

@Bean

public Docket docket()

{

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())//配置Swagger信息

.select()

/**

  • apis():指定扫描的接口

  • RequestHandlerSelectors:配置要扫描接口的方式

  •   basePackage:指定要扫描的包

  •   any:扫面全部

  •   none:不扫描

  •   withClassAnnotation:扫描类上的注解(参数是类上注解的class对象)

  •   withMethodAnnotation:扫描方法上的注解(参数是方法上的注解的class对象)

*/

.apis(RequestHandlerSelectors.basePackage(“com.Controller”))

/**

  • paths():过滤路径

  • PathSelectors:配置过滤的路径

  •  any:过滤全部路径

  •  none:不过滤路径

  •  ant:过滤指定路径:按照按照Spring的AntPathMatcher提供的match方法进行匹配

  •  regex:过滤指定路径:按照String的matches方法进行匹配

*/

.paths(PathSelectors.any())

.build();

}

其中.select().apis.paths.build是一套组合进行使用

只有被过滤筛选出来并且在指定包下面的请求路径才会显示在页面上

在这里插入图片描述

配置是否启动Swagger

我么通过Docket对象的.enable方法来配置swagger是否启动

@Bean

public Docket docket()

{

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())//配置Swagger信息

.enable(false)//enable是否启动swagger,如果为false,那么浏览器中无法访问swagger

.select()

.apis(RequestHandlerSelectors.basePackage(“com.Controller”))

.paths(PathSelectors.any())

.build();

}

在这里插入图片描述

Swagger只在生产环境下使用

  • 首先要判断是不是开发环境，可以设置一个flag表示用来表示：flag=1即表示生产环境

  • 然后将flag的值传给enable(flag)

首先在resources目录下新建两种springboot配置文件

开发环境：application-dev.properties

server.port=8081

正式环境：application-pro.properties

server.port=8082

在这里插入图片描述

然后在主配置文件application.properties中激活开发环境

spring.profiles.active=dev

然后我们到SwaggerConfig中的docket()方法中添加代码：

首先给该方法传一个参数Environment的实例

Environment environment

首先设置要配置的Swagger环境：这里可以添加多个环境

Profiles.of(“dev”, “test”);

然后通过environment.acceptsProfiles方法判断是否处在上一步设定的dev/test环境中，返回一个boolean的值，我们用flag接收

boolean flag = environment.acceptsProfiles(profiles);

然后修改enable中的参数为flag，即通过flag来判断是否开启Swagger

.enable(flag)//通过flag判断是否开启

完整代码：

@Configuration

@EnableOpenApi //开启Swagger3

public class SwaggerConfig {

//配置Swagger的Docket的bean实例

@Bean

public Docket docket(Environment environment)

{

//设置要配置的Swagger环境

Profiles p = Profiles.of(“dev”, “test”);

//通过environment.acceptsProfiles判断是否处在自己设定的环境中

boolean flag = environment.acceptsProfiles§;

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())//配置Swagger信息

.enable(flag)

.select()

.apis(RequestHandlerSelectors.basePackage(“com.Controller”))

.paths(PathSelectors.any())

.build();

}

//配置Swagger信息

private ApiInfo apiInfo() {

return new ApiInfo(

“大忽悠项目”,

“大忽悠的Swagger API文档”,

“2.0”,//版本信息

“https://blog.csdn.net/m0_53157173”,//团队信息的url

new Contact(“大忽悠”, “https://blog.csdn.net/m0_53157173”, “3076679680@qq.com”),//作者信息

/Contact(String name, String url, String email)/

“Apache 2.0”,

“http://www.apache.org/licenses/LICENSE-2.0”,

new ArrayList());

}

}

然后启动主程序测试：由于激活了dev开发环境，所以访问localhost:8081/swagger-ui.html

在这里插入图片描述

成功开启swagger，如果我们修改主配置文件，激活pro正式发布环境

spring.profiles.active=pro

再次重启主程序测试，访问端口8082对应的地址localhost:8082/swagger-ui.html

在这里插入图片描述

无法进入，因为pro环境不在我们配置的test/dev环境中，所以无法开启

配置API文档分组

1. 设置默认组名

可以看到，我们默认只有一个组且组名为default

在这里插入图片描述

我们可以在docket通过.groupName中设置组名

@Bean

public Docket docket(Environment environment)

{

//设置要配置的Swagger环境

Profiles p = Profiles.of(“dev”, “test”);

//通过environment.acceptsProfiles判断是否处在自己设定的环境中

boolean flag = environment.acceptsProfiles§;

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())//配置Swagger信息

.enable(flag)

.groupName(“大忽悠”)

.select()

.apis(RequestHandlerSelectors.basePackage(“com.Controller”))

.paths(PathSelectors.any())

.build();

}

在这里插入图片描述

2. 配置多个组

**上述我们成功修改了组名，但是只有一个组，如果我们想要多个组呢？

观察代码可以知道，一个Docket实例就对应着一个组，因此我们配置多个docket就对应着多个组**

@Bean

public Docket docket1() {

return new Docket(DocumentationType.SWAGGER_2).groupName(“大忽悠1号”);

}

@Bean

public Docket docket2() {

return new Docket(DocumentationType.SWAGGER_2).groupName(“大忽悠2号”);

}

在这里插入图片描述

配置Model实体类

只要我们的controoler层方法中，返回值中存在实体类，他就会被扫描到Swagger中

@RestController

public class UserControoler

{

//只要我们的接口中，返回值中存在实体类，他就会被扫描到Swagger中

@GetMapping(“/User”)

public User showUser(User u)

{

return u;

}

}

在这里插入图片描述

现在的问题是，页面显示出来的返回的User类，如果是非常复杂的情况下，没有注释就很难看懂，这样就有了注解来进行解释

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

@NoArgsConstructor

@AllArgsConstructor

@Data

@ApiModel(“用户实体类”)

public class User

{

@ApiModelProperty(“姓名”)

String name;

@ApiModelProperty(“年龄”)

Integer age;

@TableId(value=“id”,type = IdType.AUTO)

@ApiModelProperty(“主键id”)

Integer id;

//字段添加填充内容

@TableField(fill = FieldFill.INSERT)

@ApiModelProperty(“创建时间”)

private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)

@ApiModelProperty(“修改时间”)

private Date updateTime;

@Version

@ApiModelProperty(“版本，用于乐观锁”)

Integer version;

//逻辑删除字段

@TableLogic

@ApiModelProperty(“逻辑删除字段”)

private Integer deleted;

}

在这里插入图片描述

我们同样可以在Controller类和其中的方法上添加相应的注解

@Api

@ApiOperation

没加前:

在这里插入图片描述

加注解中…

@RestController

@Api(tags =“User数据交互”)

public class UserControoler

{

//只要我们的接口中，返回值中存在实体类，他就会被扫描到Swagger中

@GetMapping(“/User”)

@ApiOperation(“展示用户”)

public User showUser(User u)

{

return u;

}

}

效果展示:

在这里插入图片描述

@ApiParam–给参数上加上解释

@RestController

@Api(tags =“User数据交互”)

public class UserControoler

{

//只要我们的接口中，返回值中存在实体类，他就会被扫描到Swagger中

@GetMapping(“/User”)

@ApiOperation(“展示用户”)

public String showUser(@ApiParam(“特殊的名字”) String u)

{

return u;

}

}

在这里插入图片描述

我们可以简单测试一下，点击Try it out，然后点击Execute执行

在这里插入图片描述

在这里插入图片描述

常用注解总结

// @Api: 修饰整个类，描述Controller的作用

@Api(value = “注册登陆”, tags = “注册登陆相关接口”)

// @ApiOperation: 描述一个类的一个方法，或者说一个接口

@ApiOperation(value = “用户注册”, notes = “用户注册”, httpMethod = “POST”)

@ApiParam // 单个参数描述

// @ApiModel: 用对象来接收参数

@ApiModel(value = “用户对象BO”, description = “用户从客户端传入的数据的封装”)

// @ApiModelProperty: 用对象接收参数时，描述对象的一个字段

@ApiModelProperty(value = “用户名”, name = “username”, example = “Orcas”, required = true)

@ApiResponse // HTTP响应其中1个描述

@ApiResponses // HTTP响应整体描述

@ApiIgnore // 使用该注解忽略这个API

@ApiError // 发生错误返回的信息

@ApiImplicitParam // 一个请求参数

@ApiImplicitParams // 多个请求参数

=》 @ApiImplicitParams({

@ApiImplicitParam(name = “page”, value = “页码”, required = true, paramType = “path”, dataType = “int”),

@ApiImplicitParam(name = “size”, value = “每页记录数”, required = true, paramType = “path”, dataType = “int”)})

@ApiImplicitParam属性

在这里插入图片描述

总结: 发布的时候，记得关闭Swagger，可以通过生产环境设置来完成这一需求

最后

Java架构进阶面试及知识点文档笔记

这份文档共498页，其中包括Java集合，并发编程，JVM，Dubbo,Redis，Spring全家桶，MySQL，Kafka等面试解析及知识点整理

image

Java分布式高级面试问题解析文档

其中都是包括分布式的面试问题解析，内容有分布式消息队列，Redis缓存，分库分表，微服务架构，分布式高可用，读写分离等等！

image

互联网Java程序员面试必备问题解析及文档学习笔记

image

Java架构进阶视频解析合集
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！
piImplicitParam属性**

在这里插入图片描述

总结: 发布的时候，记得关闭Swagger，可以通过生产环境设置来完成这一需求

最后

Java架构进阶面试及知识点文档笔记

这份文档共498页，其中包括Java集合，并发编程，JVM，Dubbo,Redis，Spring全家桶，MySQL，Kafka等面试解析及知识点整理

[外链图片转存中…(img-plCSIQFZ-1714769130465)]

Java分布式高级面试问题解析文档

其中都是包括分布式的面试问题解析，内容有分布式消息队列，Redis缓存，分库分表，微服务架构，分布式高可用，读写分离等等！

[外链图片转存中…(img-6vohvfWV-1714769130465)]

互联网Java程序员面试必备问题解析及文档学习笔记

[外链图片转存中…(img-DWQMBzR1-1714769130466)]

Java架构进阶视频解析合集
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！

2401_84091544
关注
  • 21
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger-editor3
06-01
swagger-editor最新版本。。
springboot - 2.7.3版本 - （三）整合Swagger3
09-22
Swagger3则是用于构建RESTful API的API文档工具，它允许开发者通过注解来描述API，生成交互式的文档，极大地提高了前后端联调的效率。在SpringBoot项目中整合Swagger3，可以实现自动化接口文档的生成，为团队协作...
swagger3
qq_36022463的博客
10-13 714
swagger 用于生成，描述，调用，可视化 RESTFUL风格的web服务。 在swargger2中需要导两个依赖： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dep
Swagger 3.0使用介绍
最新发布
Java毕设项目分享
05-20 584
Swagger 是一套基于 OpenAPI 规范（OpenAPI Specification，OAS）构建的开源工具，后来成为了 Open API 标准的主要定义者，现在最新的版本为17年发布的 Swagger3（Open Api3）。国内绝大部分人还在用过时的swagger2（17年停止维护并更名为swagger3） 对于 Rest API 来说很重要的一部分内容就是文档，Swagger 为我们提供了一套通过代码和注解自动生成文档的方法，这一点对于保证API 文档的及时性将有很大的帮助。
Swagger3
qq_42920045的博客
06-09 525
导入pom <!--swagger, 内包含 springfox-swagger2,springfox-swagger-ui--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </depen.
Swagger3.0.0
weixin_45365220的博客
03-31 2226
作为一个RESTful风格的可视化框架，经常会和yapi作个比较， 相比于yapi其优势展现在： 自动实时更新接口信息 更强大的接口信息描述注解 劣势在于： 代码侵入性强 UI不如Yapi好看（当然swagger的UI页面支持引入更换，且swagger3的UI比以往版本好看一些） Yapi还有权限管理、团队协作、自动化测试等功能 Swagger3目前已经将注解规范化，基于openApi3，且兼容以往版本的注解和配置 今天我们来看看简单的Swagger3版本整合到springboot项目中 pom依赖
Spring Boot技术知识点：Spring Boot2.7以上支持使用Swagger3
06-30
在Spring Boot 2.7及以上版本，它开始支持Swagger 3，这是一个强大的API文档工具，帮助开发者构建清晰、易于理解的RESTful API接口。 Swagger 3，也称为OpenAPI Specification 3.0，是Swagger的最新版本，基于...
swagger3-demo.zip
01-04
1. **源代码**：可能包含用 Java 或其他支持 Swagger3 的语言编写的后端服务代码。这些代码通常会使用 Swagger 的注解（如 `@ApiOperation`，`@ApiParam` 等）来描述 API 的各个部分，包括路由、HTTP 方法、参数、...
swagger_1.zip
10-08
3. **使用 Swagger2**： - **注解集成**：在 Java 中，可以通过 Swagger2 的注解（如 `@ApiOperation`、`@ApiParam` 等）来标记方法和参数，生成 API 文档。 - **配置**：设置 Swagger2 的配置信息，如 API 的版本...
Spring Boot 2.7.5 集成 Swagger 3
11-22
Swagger 3，即OpenAPI Specification的第三个主要版本，是一个用于描述RESTful API的规范，它提供了强大的工具来生成、测试和文档化API。集成Swagger 3到Spring Boot项目中，可以帮助开发者更有效地管理和维护API，...
swagger本地程序
06-06
1. **实时预览**：在编辑规范的同时，Swagger Editor会实时显示预览，帮助开发者直观地理解API的结构和功能。 2. **语法高亮与提示**：提供代码编辑器风格的界面，包含自动补全和错误检测，方便快速编写规范。 3. ...
swagger官方文档离线版
10-26
1. **定义API**：Swagger 2.0允许你使用JSON格式定义API接口，包括端点（URL）、HTTP方法、请求参数、响应状态码和响应模型等。这使得API的描述清晰、结构化且易于理解。 2. **信息交换模型**：Swagger 2.0使用`...
Swagger 学习Demo
04-16
1. **API定义**：这是使用OAS创建的JSON或YAML文件，通常命名为`swagger.yaml`或`swagger.json`。在这个文件中，你可以详细描述每个HTTP操作（GET、POST等）、URL路径、请求和响应参数、数据模型等。 2. **@Api注解...
swagger测试获取token
02-14
1. Swagger：一个用于描述和测试RESTful API的工具。 2. 前后端分离：前端与后端的职责分离，通常通过API进行通信。 3. 认证与授权：OAuth2、JWT等机制，用于验证用户身份并控制权限。 4. Token：在API调用中用于...
swagger.zip
04-30
1. **Swagger Core**: 这是Swagger框架的核心部分，它允许你在Java应用中嵌入Swagger元数据。Swagger Core可以读取Java注解，解析API的路由、参数和响应，然后生成相应的OpenAPI规范文档。 2. **Swagger UI**: 这是...
Spring Boot之Swagger 3.0
拾一二的博客
12-26 2296
目录 前言 ​ 什么是Swagger 有用的链接 项目集成 1、添加依赖 2、启动类配置 3、启动项目 分组 第一步：添加Swagger3自定义配置类（可选） 第二步：属性文件配置 授权 如何添加授权信息？ 如何携带公共的请求参数？ 格式美化 第一步：添加bootstrap-ui支持 第二步：启动项目 注解说明 示例代码 注解 前言 这是一个突破性的变更 有关此项目的更多信息，请访问API Documentation & Design To...
Swagger 3.0快速入门
热门推荐
m0_53157173的博客
08-06 1万+
Swagger快速入门一。Swagger简介1. 前后端分离2. Swagger引入springfox-swagger 2SpringFox 3.0.0 发布swagger3.0 与2.xx配置差异：具体使用教程如下1.导入依赖2.application.yml配置3.配置Swagger API信息4.修改默认API文档显示页面配置Swagger自定义扫描接口自定义扫描接口配置是否启动SwaggerSwagger只在生产环境下使用配置API文档分组1. 设置默认组名2. 配置多个组配置Model实体类只要我
Swagger3学习
weixin_43897772的博客
11-18 254
1.使用 1.1导入依赖 <!--Swagger3依赖导入--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> <
struts1整合swagger3
05-13
要在Struts1中整合Swagger3，需要执行以下步骤： 1. 在项目中添加Swagger3依赖项。可以使用Maven或Gradle构建工具来添加依赖项。 2. 创建Swagger配置类。为了在Struts1中使用Swagger3，需要创建一个Swagger配置类，该类应该包含以下内容： ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo")) .paths(PathSelectors.any()) .build(); } } ``` 3. 添加Swagger UI依赖项。Swagger UI是一个可视化工具，可以帮助我们查看和测试API文档。可以通过以下方式将Swagger UI添加到项目中： ``` <dependency> <groupId>org.webjars</groupId> <artifactId>swagger-ui</artifactId> <version>3.50.0</version> </dependency> ``` 4. 配置Struts1 Action类。在Action类中添加以下注释： ``` @Api(value = "users", description = "Operations pertaining to users") ``` 其中，value属性是API路径，description属性是API描述。 5. 启动应用程序并访问Swagger UI。启动应用程序并在浏览器中访问Swagger UI，例如： ``` http://localhost:8080/swagger-ui.html ``` 现在，您可以使用Swagger UI查看和测试API文档。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值