Nest框架中集成使用Swagger示例说明

目录
  • Swagger
  • Nest 中使用 Swagger
    • 安装
    • 初始化 Swagger
    • 接口中使用

Swagger

Swagger 是一个能够生成、描述、调用和可视化的 RESTful 风格的 Web 服务。主要是对 REST API 接口自动生成接口说明文档。生成的接口文档也是直接在线测试。即在可视化的Web 界面上直接输入参数对应的值就可以在线测试接口。

Nest 框架也提供了一个专门用于支持 Swagger 规范的模块。

Nest 中使用 Swagger

安装

首先需要安装所需要的 swagger 包

 npm install --save @nestjs/swagger swagger-ui-express

初始化 Swagger

在 Nest 项目的 main.ts 文件中，使用 SwaggerModule 类初始化 Swagger

import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
async function bootstrap() {
    const options = new DocumentBuilder()
    .setTitle('Api example')
    .setDescription('The API description')
    .setVersion('1.0')
    .addTag('Api/V1')
    .build();
  const document = SwaggerModule.createDocument(app, options);
  SwaggerModule.setup('api', app, document);
}
  • DocumentBuilder : 先new 一个 DocumentBuilder 实例，主要是为构建符合 OpenApi规范的基础文档，从以上Demo中可以看到可以对 Swagger 文档设置标题、描述、版本号、tag的相关属性。
  • createDocument()：用于创建文档。该方法主要接收两个参数：一个是 app 应用程序实例，一个是 Swagger 选项对象。

创建完文件之后，即可调用 setup 方法。

配置完之后，就可以在运行项目，通过访问 http://localhost:3000/api， 就可以打开 Swagger 的可视化界面，其中就会展示所有的接口列表。

接口中使用

所有的配置都已就位，接下来就是将每个接口都配置上 swagger ，以便接口能够展示在可视化 web界面上。

首先需要引用可支持 Swagger 的模块

import { ApiProperty } from '@nestjs/swagger';

在使用相关支持Swagger 的装饰器方法，比如 @ApiProperty() 装饰器注释所有的属性。

@ApiTags('user')
@Controller('api/v1/user')
export class UserController {
    @Post()
    @ApiCreatedResponse({
    description: 'The record has been successfully created.',
    type: User
    })
    async CreateUser(@Body() userDto:UserDto){
      // doing something
    }
}
export class UserDto {
    @ApiProperty()
    name: string;
    @ApiProperty()
    age: number
}

ApiTags :将控制器附加到特定的标签

@ApiResponse()：自定义 Http 响应

@ApiProperty() 为请求指定返回模型，创建 Dto 类并使用装饰器注释所有的属性

这样设置之后，运行项目，访问 swagger 可视化界面就可以看到界面，并且在界面上测试该接口。

参考资料：docs.nestjs.cn/9/recipes?i…

以上就是Nest框架中集成使用Swagger示例说明的详细内容，更多关于Nest框架集成Swagger的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • NestJs使用Mongoose对MongoDB操作的方法

    NestJs使用Mongoose对MongoDB操作的方法

    最近开始学习NestJs这个框架.学习成本比其他框架相对高了很多. 其注册配置相对复杂一开始学起来有点摸不着哪跟哪:但这也是相比其他框架更规范严谨的体现.保证了大型项目的稳定健壮的使用! 在学习node基础框架Express和Koa的时候.对数据库的操作一直都是以编写SQL语句实现.需要什么编写什么.这样显得非常死板也不灵活.后来了解到NestJs是OOP思想编程(NestJs可以使用TypeScript也是OOP思想)才知道原来对数据库的操作可以用对象形式体现.在数据库中每一个表(Schema

  • nestjs返回给前端数据格式的封装实现

    一般开发过程中不不会根据httpcode来判断接口请求成功与失败的,而是会根据请求返回的数据,里面加上code字段 一.返回的数据格式对比 1.直接返回的数据格式 { "id": 1, "uuid": "cbbe7abc-b95e-48a0-8d24-b1ac93c45328", "name": "哈士奇1", "age": 12, "color": null, &q

  • NestJS+Redis实现缓存步骤详解

    NestJS+Redis实现缓存步骤详解

    NestJS的缓存模块天生支持Redis等缓存机制.以下通过一个示例,说明如何在NestJS中操作Redis.步骤如下: 先安装运行Redis服务,步骤参见链接 新建nestjs项目: nest new [项目名称] 安装cache相关依赖 npm install cache-manager npm install -D @types/cache-manager npm install cache-manager-redis-store --save 注册Redis Store 打开src->a

  • 在nest.js中通过正则表达式正确设置验证的方法

    在nest.js中通过正则表达式正确设置验证的方法

    下面看下nest.js正则表达式设置验证的方法,代码如下所示: import { IsNotEmpty, Length, Matches, Max, Min } from "class-validator"; const phoneReg = /^1(3\d|4[5-9]|5[0-35-9]|6[567]|7[0-8]|8\d|9[0-35-9])\d{8}$/ 补充:下面看下js正则表达式验证大全 /判断输入内容是否为空     function IsNull(){        

  • Flutter 首页必用组件NestedScrollView的示例详解

    昨天Flutter 1.17版本重磅发布,新的版本主要是优化性能.修复bug,有人觉得此版本毫无亮点,但也从另一方面体现了Flutter目前针对移动端已经较为完善,想了解具体内容,文末有链接,如果你想升级到最新版本,建议慎重,有些人升级后项目无法运行. 今天介绍的组件是NestedScrollView,大部分的App首页都会用到这个组件. 可以在其内部嵌套其他滚动视图的滚动视图,其滚动位置是固有链接的. 在普通的ScrollView中, 如果有一个Sliver组件容纳了一个TabBarView,

  • Nest.js参数校验和自定义返回数据格式详解

    0x0 参数校验 参数校验大部分业务是使用 Nest.js 中的管道 方法实现,具体可以查阅文档 .不过编写过程中遇到一些问题,虽然文档讲得比较晦涩. 在做个查询接口,里面包含一些参数,做成 dto 结构数据: import { ApiProperty } from '@nestjs/swagger' export class QueryUserDto { @ApiProperty({ required: false, description: '页码' }) readonly currentP

  • Nest框架中集成使用Swagger示例说明

    Nest框架中集成使用Swagger示例说明

    目录 Swagger Nest 中使用 Swagger 安装 初始化 Swagger 接口中使用 Swagger Swagger 是一个能够生成.描述.调用和可视化的 RESTful 风格的 Web 服务.主要是对 REST API 接口自动生成接口说明文档.生成的接口文档也是直接在线测试.即在可视化的Web 界面上直接输入参数对应的值就可以在线测试接口. Nest 框架也提供了一个专门用于支持 Swagger 规范的模块. Nest 中使用 Swagger 安装 首先需要安装所需要的 swag

  • Laravel框架中集成MongoDB和使用详解

    * 推荐组件 composer require jenssegers/mongodb ^3.3 -vvv(本人的laravel版本是5.5) 修改config/app.php * 注册服务 Jenssegers\Mongodb\MongodbServiceProvider::class, * 添加 Facades 'Mongo' => Jenssegers\Mongodb\MongodbServiceProvider::class, * 修改数据库配置文件 config/database.php

  • Python的Flask框架中集成CKeditor富文本编辑器的教程

    CKeditor是目前最优秀的可见即可得网页编辑器之一,它采用JavaScript编写.具备功能强大.配置容易.跨浏览器.支持多种编程语言.开源等特点.它非常流行,互联网上很容易找到相关技术文档,国内许多WEB项目和大型网站均采用了CKeditor. 下载CKeditor 访问CKeditor官方网站,进入下载页面,选择Standard Package(一般情况下功能足够用了),然后点击Download CKEditor按钮下载ZIP格式的安装文件.如果你想尝试更多的功能,可以选择下载Full

  • Spring Boot框架中的@Conditional注解示例详解

    Spring Boot框架中的@Conditional注解示例详解

    目录 1. @Conditional 注解 2. Spring boot 扩展 1) @ConditionalOnClass和@ConditionalOnMissingClass注解 2) @ConditionalOnBean 和@ConditionalOnMissingBean注解 3) @ConditionalOnProperty注解 1. @Conditional 注解 @Conditional注解是Spring-context模块提供了一个注解,该注解的作用是可以根据一定的条件来使@Co

  • CI框架中zip类应用示例

    CI框架自带的zip类简单实用,本文就来简单说一下CI框架的zip类的使用. 首先需要导入zip类: 复制代码 代码如下: $this->load->('zip'); 此外,但是考虑到CI的结构,还需要设置一下自动加载类,把zip加载进去.也可以在设置的时候,统一加载.大家如果遇到这个问题可能就是自动加载没有加载zip类.具体调用方法如下: 复制代码 代码如下: $path = $_SERVER['DOCUMENT_ROOT'];//需要压缩的文件夹路径$this->zip->re

  • CI框架中集成CKEditor编辑器的教程

    1.将fckeditor目录置入CI_PATH/system/plugins/ 2.在CI_PATH/system/application/config/config.php中加入: $config['fckeditor_basepath'] = "/system/plugins/fckeditor/"; $config['fckeditor_toolbarset_default'] = 'Default'; 3.创建helper,在/system/application/helper

  • SSM框架整合JSP中集成easyui前端ui项目开发示例详解

    SSM框架整合JSP中集成easyui前端ui项目开发示例详解

    目录 前言 EasyUI下载与配置 页面美化 运行结果 总结与问题 前言 前端的UI框架很多,如bootsrap.layui.easyui等,这些框架提供了大量控件供开发人员使用,我们无需花费太大的精力,使得我们的页面具有专业标准,使用起来也很简单.所有的前端框架使用方式基本上大同小异,以下使用easyui作为UI框架做一演示,个人认为easyui提供的控件比较好看. EasyUI下载与配置 使用EasyUI,必须下载其js包,下载官网地址:https://www.jeasyui.cn/ 下载j

  • 在SpringBoot项目中的使用Swagger的方法示例

    在SpringBoot项目中的使用Swagger的方法示例

    一. 首先Swagger是什么? Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger官方API文档:https://swagger.io/ 作用:   1. 接口的文档在线自动生成.   2. 功能测试. Swagger的主见介绍:    Swagger Codegen: 通过Codegen 可

  • Springboot中集成Swagger2框架的方法

    Springboot中集成Swagger2框架的方法

    摘要:在项目开发中,往往期望做到前后端分离,也就是后端开发人员往往需要输出大量的服务接口,接口的提供方无论是是Java还是PHP等语言,往往会要花费一定的精力去写接口文档,比如A接口的地址.需要传递参数情况.返回值的JSON数据格式以及每一个字段说明.当然还要考虑HTTP请求头.请求内容等信息.随着项目的进度快速高速的迭代,后端输出的接口往往会面临修改.修复等问题,那也意味着接口文档也要进行相应的调整.接口文档的维护度以及可读性就大大下降. 既然接口文档需要花费精力去维护,还要适当的进行面对面交

  • Angular学习笔记之集成三方UI框架、控件的示例

    本文介绍了Angular学习笔记之集成三方UI框架.控件的示例,分享给大家,具体如下: 安装 Material UI 方法: Material 官网:https://material.angular.io step 1: npm install --save @angular/material @angular/cdk step 2: npm install --save @angular/animations step 3: angular.cli ../node_modules/@angul

随机推荐