Nest框架中集成使用Swagger的方法


这篇“Nest框架中集成使用Swagger的方法”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Nest框架中集成使用Swagger的方法”文章吧。Swagger 是一个能够生成、描述、调用和可视化的 RESTful 风格的 Web 服务。主要是对 REST API 接口自动生成接口说明文档。生成的接口文档也是直接在线测试。即在可视化的Web 界面上直接输入参数对应的值就可以在线测试接口。Nest 框架也提供了一个专门用于支持 Swagger 规范的模免费云主机域名块。首先需要安装所需要的 swagger 包在 Nest 项目的 main.ts 文件中,使用 SwaggerModule类初始化 SwaggerDocumentBuilder : 先new 一个 DocumentBuilder 实例,主要是为构建符合 OpenApi规范的基础文档,从以上Demo中可以看到可以对 Swagger 文档设置标题、描述、版本号、tag的相关属性。createDocument():用于创建文档。该方法主要接收两个参数:一个是 app 应用程序实例,一个是 Swagger 选项对象。创建完文件之后,即可调用 setup 方法。配置完之后,就可以在运行项目,通过访问 http://localhost:3000/api, 就可以打开 Swagger 的可视化界面,其中就会展示所有的接口列表。所有的配置都已就位,接下来就是将每个接口都配置上 swagger ,以便接口能够展示在可视化 web界面上。首先需要引用可支持 Swagger 的模块在使用相关支持Swagger 的装饰器方法,比如 @ApiProperty() 装饰器注释所有的属性。ApiTags :将控制器附加到特定的标签@ApiResponse():自定义 Http 响应@ApiProperty() 为请求指定返回模型,创建 Dto 类并使用装饰器注释所有的属性这样设置之后,运行项目,访问 swagger 可视化界面就可以看到界面,并且在界面上测试该接口。以上就是关于“Nest框架中集成使用Swagger的方法”这篇文章的内容,相信大家都有了一定的了解,希望小编分享的内容对大家有帮助,若想了解更多相关的知识内容,请关注百云主机行业资讯频道。

相关推荐: 如何用c语言代码将大写字母转成小写字母

这篇文章主要介绍“如何用c语言代码将大写字母转成小写字母”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“如何用c语言代码将大写字母转成小写字母”文章能帮助大家解决问题。功能说明:当输入”./upper_to_lower.…

免责声明:本站发布的图片视频文字,以转载和分享为主,文章观点不代表本站立场,本站不承担相关法律责任;如果涉及侵权请联系邮箱:360163164@qq.com举报,并提供相关证据,经查实将立刻删除涉嫌侵权内容。

(0)
打赏 微信扫一扫 微信扫一扫
上一篇 03/25 20:57
下一篇 03/25 20:58

相关推荐