【NestJS】swagger4.0 重大更改/ API 更改

最新推荐文章于 2024-07-18 11:05:06 发布
最新推荐文章于 2024-07-18 11:05:06 发布
阅读量888 收藏
点赞数
分类专栏： NestJS
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/npl2580/article/details/117788928
版权

今天安装swagger发现一些方法报错，查看下主要是版本升级有很多API变更了，记录下变更的地方方便查阅

 

以下装饰器已经被更改/重命名：

  • @ApiModelProperty 现在是 @ApiProperty
  • @ApiModelPropertyOptional 现在是 @ApiPropertyOptional
  • @ApiResponseModelProperty 现在是 @ApiResponseProperty
  • @ApiImplicitQuery 现在是 @ApiQuery
  • @ApiImplicitParam 现在是 @ApiParam
  • @ApiImplicitBody 现在是 @ApiBody
  • @ApiImplicitHeader 现在是 @ApiHeader
  • @ApiOperation({{ '{' }} title: 'test' {{ '}' }}) 现在是 @ApiOperation({{ '{' }} summary: 'test' {{ '}' }})
  • @ApiUseTags 现在是 @ApiTags

DocumentBuilder 重大更改（更新的方法签名）:

  • addTag
  • addBearerAuth
  • addOAuth2
  • setContactEmail 现在是 setContact
  • setHost 已经被移除
  • setSchemes 已经被移除

 

如下方法被添加：

  • addServer
  • addApiKey
  • addBasicAuth
  • addSecurity
  • addSecurityRequirements

 

程序员查理
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
监控swagger 接口变动
sinat_36024346的博客
03-02 1650
简介 采用swagger-diff工具，自动监控swagger API 变动情况，不需要人工维护文档说明API变动情况 可结合Gitlab等工具实现API历史版本维护 工具 swagger-diff GitHub - Sayi/swagger-diff: Compare two swagger API specifications(1.x or v2.0) 原理 效果图 ...
Swagger4 深入了解一下
weixin_33729196的博客
03-15 725
4.1私人定制（根据数据的type来对数据进行限制） 4.1.1字符串长度和格式 当定义一个字符串属性时，我们可以定制它的长度和格式 eg username: type:string pattern:"[a-z0-9]{8,64}" #用正则表达式定义字符串的格式 minLength:8 #字...
SpringBoot集成Swagger4
EPW云沐
03-16 814
我们添加了Swagger 4的依赖，并创建了一个Swagger配置类来配置Swagger。Docket是Swagger的主配置类，它可以配置Swagger的各种属性，例如文档类型、API选择、API路径等等。在Swagger UI中，您可以查看您的API文档，并使用Swagger的交互式界面测试您的API。上面的代码配置了API选择和API路径，使Swagger能够自动检测项目中的所有API并生成文档。在Spring Boot项目中，我们可以通过创建一个Swagger配置类来配置Swagger。
Nest.js 实战 (三)：使用 Swagger 优雅地生成 API 文档
最新发布
白雾茫茫丶
07-18 1154
这篇文章介绍了Swagger，它是一组开源工具，围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具，包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger，展示了安装依赖、定义DTO和控制器等步骤，以及如何使用Swagger装饰器。文章最后总结说，集成Swagger文档可以自动生成和维护API文档，规范API标准化和一致性，但会增加开发者工作量，需要保持注释和装饰器的准确性。
Swagger4.0基于SpringBoot使用教程
q_1092535160的博客
08-24 2853
【版权所有，文章允许转载，但须以链接方式注明源地址，否则追究法律责任】 【创作不易，点个赞就是对我最大的支持】 前言 仅作为学习笔记，供大家参考 文章目录前言一、SpringBoot项目引入依赖二、创建Swagger工具类三、Controller类测试四、页面使用方法1.首页2.查看接口详情3.调试4.生成接口文档4.1效果图五、使用总结 一、SpringBoot项目引入依赖 <parent> <groupId>org.springframework.boot.
Swagger（4）：Swagger配置
u013938578的博客
11-18 255
3.1自定义注解注解名称随意，我这边新建MyAnnotation4Swagger。/*** @Target - 描述当前的注解可以定义在什么资源上。* 属性 value* - 定义具体的资源。包括：* - ElementType.METHOD 可以定义在方法上* - ElementType.TYPE 可以定义在类型上* - ElementType.FIELD 可以定义在属性上* - ElementType.PARAMETER 可以定义在方法参数上。
swagger：用于Nest框架（node.js）的OpenAPI（Swagger）模块
02-04
如果您当前正在使用@nestjs/swagger@3.* ，请注意4.0版中的以下@nestjs/swagger@3.* / API更改。 以下装饰器已更改/重命名： @ApiModelProperty现在是@ApiProperty @ApiModelPropertyOptional现在为@...
NestJS-RestAPI-starter：完整的入门包基于REST API的NodeJS
02-03
Node JS REST API入门包 这是基于REST API NodeJS的入门包，用于使用企业体系结构快速开发高级API服务。 安装 npm install 用法 开发模式 npm run start 生产 npm run start:prod 运行测试 npm run test 特征： ...
swagger-lint-api:Swagger JSON API 规范的 Linter
05-31
swagger-lint-api Swagger JSON API 规范的 Linter关于Swagger JSON API 规范的 Linter安装npm install --save swagger-lint-api用法该库公开了要与OpenAPI / Swagger JSON格式的架构一起使用的验证器： 需要图书馆...
Nestjs基础到实战.pdf
08-31
在第二章中，NestJS 教程介绍了 RESTful API 设计指南，如何接收客户端传递的参数，以及如何利用 EJS 模板引擎进行视图渲染。此外，还涵盖了 Cookie 和 Session 的管理，这对于处理用户会话和状态非常关键。 ...
nestjs-swagger-poc:POC展示@ApiHeader中的问题
04-06
development$ npm run start# watch mode$ npm run start:dev# production mode$ npm run start:prod测试# unit tests$ npm run test# e2e tests$ npm run test:e2e# test coverage$ npm run test:cov支持Nest是MIT...
swagger4spring-web, 对 Spring MVC的Swagger支持.zip
09-18
swagger4spring-web, 对 Spring MVC的Swagger支持 swagger4spring-web请注意：这里项目不再主动支持。支持 Swagger 1.3，版本 0.3.0 ！这个项目旨在为基于spring的应用提供Swagger支持。 它将尝试基于现有的spring站点注释来记录你的API
4.整合swagger
gunsmoke的专栏
03-30 145
引入依赖 <!--swagger--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <scope...
四、swagger的简单使用
banqiang3154的博客
07-11 121
一、swagger的简单使用： 　　第一步：引入依赖：　 <!-- swagger2 --><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version&g...
SpringBoot+JPA+Swagger(4)
Dr.sen的博客
08-18 208
SpringBoot+JPA+Swagger(4) 这几天主要是熟悉公司的项目生成工具,遇到并解决了其中几个bug 问题一: JPA建表失败,所有实体类均无法自动建表 因为实体类属性在数据库表中的属性赋值时,未小写,导致JPA建表时无法识别 例如: varchar类型,却赋了一个VARCHAR,数据库无法识别,就没有建表,之后的插入外键时,检测数据库不存在就会报错 因此在控制台报的只有插入外键时错误,causeby 数据库表 dont exit 问题二:插入数据时,UUID与实际解析的XML对应UUID
Java Swagger：（四）Swagger-UI 使用
地球村
08-14 797
Swagger-UI 使用 访问 swagger-ui.html 后可以在页面中看到所有需要生成接口文档的控制器名称。 每个控制器中间包含多所有控制器方法的各种访问方式。如果使用的是@RequestMapping 进行映射，将显示下面的所有请求方式。如果使用@PostMapping 将只有 Post 方式可以能访问，下面也就只显示 Post 的一个。 点击某个请求方式中 try it out 会出现界面要求输入的值。输入完成后点击 Execute 按钮 下面会出现 Request URL 以及不同
nest集成swagger
weixin_44828005的博客
04-25 2470
文章问题导向 如何集合 与 使用swagger? 如果你都有了答案，可以忽略本文章，或去nest学习导图寻找更多答案 优缺点 优点：不用写接口文档，在线生成，自动生成，可操作数据库，完美配合dto 缺点：多一些代码，显得有点乱，习惯就好 第一步：安装 yarn add @nestjs/swagger swagger-ui-express -D 第二步：在main.ts引入并配置 import { NestFactory } from '@nestjs/core'; import { AppMo
SpringBoot项目如何集成Api框架Swagger
一位热心网友的博客
11-05 369
Swagger官网：https://swagger.io/ 使用Swagger 要求：jdk 1.8 + 否则swagger2无法运行 步骤： 1、新建一个SpringBoot-web项目 2、添加Maven依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId>
NestJS入门及实战（二）Swagger接口文档
随便写写
03-30 1292
nestjs的快速入门和实战，搭建一个企业级nest模板
swagger关闭/v2/api-docs仍然可以访问漏洞 如何解决
05-27
要解决Swagger关闭/v2/api-docs仍然可以访问漏洞，您可以采取以下措施： 1. 禁用Swagger的UI页面，这可以通过在Spring Boot应用程序的配置文件中添加如下配置实现： ``` springfox.documentation.swagger-ui....
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

程序员查理

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

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

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

打赏作者

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

抵扣说明：

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

余额充值