NestJs Swagger混合类型 - 腾讯云开发者社区

文章/答案/技术大牛

发布

NestJS 7.x 折腾记: (4) Swagger接入及相关用法

yarn add @nestjs/swagger swagger-ui-express 配置抽离的环境变量(dev.local.env) # ------- Node服务相关 ------------...: Record[];// 没用过 } import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger.../config/env/swagger.config'; import { NestFactory } from '@nestjs/core'; import { ValidationPipe } from...{ required:false}) 就等同于下面, @ApiPropertyOptional() : 这个是上个基础上把必填变成选填我们看下typescript的声明~~~ // 相当直观,大多数类型的及区间的限制都能一目了然...: any[]; } import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; export enum UserRole

2K1 0

Nest.js 实战 (三)：使用 Swagger 优雅地生成 API 文档

、统一的结构，用于跨各种描述语言和序列化格式描述 API Nest 集成 Swagger 1、安装依赖 pnpm add @nestjs/swagger swagger-ui-express 2、..., SwaggerModule } from '@nestjs/swagger'; import { AppModule } from '....{ ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger'; // swagger 接口文档 import { PostParamsDto...、请求参数或响应参数，包括名称、类型、描述等 @ApiBody 指定请求体的 DTO 类型，用于描述请求体的结构 @ApiResponse 描述 API 的响应，包括状态码、描述等 @ApiBearerAuth...描述请求头信息，包括名称、类型、描述等 @ApiExcludeEndpoint 标记一个控制器方法不在 Swagger UI 中显示效果图总结在 Nest 中集成 Swagger 文档可以帮助开发者自动生成和维护

1.2K1 1

您找到你想要的搜索结果了吗？

是的

没有找到

Nest.js 从零到壹系列（七）：讨厌写文档，Swagger UI 了解一下？

- 覃超的回答 - 知乎[2] Swagger 之旅初始化 Swagger $ yarn add @nestjs/swagger swagger-ui-express -S 安装完依赖包后，只需要在.../filter/any-exception.filter'; import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async...string; @ApiProperty() @IsNotEmpty({ message: '真实姓名不能为空' }) @IsString({ message: '真实姓名必须是 String 类型.../user.dto'; import { ApiTags } from '@nestjs/swagger'; @ApiTags('user') // 添加接口标签装饰器 @Controller('.../user.dto'; import { ApiTags, ApiBearerAuth } from '@nestjs/swagger'; @ApiBearerAuth() // Swagger 的

5.3K1 0

基于Nest快速构建Web应用

这里简单介绍一下什么是Nestjs Nestjs是一个用于构建高效且可伸缩的服务端应用程序的渐进式 Node.js 框架。...7.5.1 核心包 @nestjs/config 环境变量治理 @nestjs/swagger 生成接口文档 swagger-ui-express 装@nestjs/swagger 必装的包处理接口文档样式...─exception # 异常分类 ├─filters # 过滤器 ├─guard # 守卫 ├─interceptor # 转换器 ├─interfaces # 所有类型接口文件...文档相关 SWAGGER_UI_TITLE = Fast-nest-temp 接口文档 SWAGGER_UI_TITLE_DESC = 接口文档 SWAGGER_API_VERSION = 0.0.1...SWAGGER_SETUP_PATH = api-docs SWAGGER_ENDPOINT_PREFIX = nest_api # 开发模式相关 NODE_ENV=development #

2K1 0

Swagger + Nest.js：打通全栈之路，API 文档生成的秘籍

安装依赖npm install --save @nestjs/swagger swagger-ui-express配置swagger 模块import { DocumentBuilder, SwaggerModule...} from '@nestjs/swagger';export const swaggerConfig = new DocumentBuilder() .setTitle('海军记账后台服务')...在主模块引入 swagger 模块import { NestFactory } from '@nestjs/core';import { AppModule } from '....@ApiParam 描述路径参数、请求参数或响应参数，包括名称、类型、描述等。提供详细的参数信息，方便开发者正确使用和理解 API。...@ApiBody 指定请求体的 DTO 类型，用于描述请求体的结构。明确请求体的结构，帮助开发者正确发送请求。

5330 0

【Nest教程】集成Swagger自动生成接口文档

Swagger很好的解决了这个问题，它可以动态生成Api接口文档，今天我们简单说下在Nest项目中集成Swagger。...1 安装Swagger yarn add @nestjs/swagger swagger-ui-express --save 2 配置Swagger 需要在src目录下main.ts文件中配置及构建出口...，内容如下： import { NestFactory } from '@nestjs/core'; import { ValidationPipe } from '@nestjs/common';...import { NestExpressApplication } from '@nestjs/platform-express'; import { AppModule } from '..../interceptor/transform.interceptor'; // api文档插件 import { SwaggerModule, DocumentBuilder } from '@nestjs

3.2K14 11

【Nest教程】实现一个简单的用户增删改查功能

{ type: 'datetime', nullable: true, name: 'update_time' }) updateTime: number; } 上面的内容定义的是表的字段及字段类型等.../swagger'; import { Controller, Get, Post, Body, Logger } from '@nestjs/common'; import { UserService.../swagger'; import { IsNotEmpty } from 'class-validator'; export class AddUserDto { @ApiProperty().../swagger'; import { IsNotEmpty, IsInt } from 'class-validator'; export class DeleteUserDto { @ApiProperty.../swagger'; import { IsNotEmpty, IsInt } from 'class-validator'; export class UpdateUserDto { @ApiProperty

2.4K13 11

Nest集成Swagger并部署至YAPI

集成Swagger 首先，我们通过yarn安装三个依赖包，如下所示： yarn add @nestjs/swagger swagger-ui-express fastify-swagger 安装完成后...，我们打开项目的入口文件main.ts添加如下所示的代码： import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger"; async.../node_modules/@nestjs/mapped-types/dist/type-helpers.utils.js 69:27-63 Module not found: Error: Can't.../microservices", "@nestjs/microservices/microservices-module", "@nestjs/websockets...): https://docs.nestjs.cn/7/recipes?

2.1K4 0

NestJS 7.x 折腾记: (2) 环境变量及配置维护

__joi : joi的typescript声明 # @nestjs/config 内置了dotenv yarn add @nestjs/config joi yarn add -D @types/hapi...__joi 基础配置介绍 @nestjs/config 选项解释 export interface ConfigModuleOptions { isGlobal?...SWAGGER_UI_TITLE: Joi.string().default('Swagger文档标题'), SWAGGER_UI_TITLE_DESC: Joi.string...import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; import { AppModule } from '..../config/env/swagger.config'; import { NestFactory } from '@nestjs/core'; import { ValidationPipe } from

4.6K1 0

从零开始的 Nest.js

Swagger 正是因为 nest 集成了 swagger 自动生成文档，我对他产生了非常好的影响。不用手动写文档，根据模型的字段和类型就能生成每个 api 的文档。简直不要太爽。...1yarn add @nestjs/swagger swagger-ui-express COPY 在 app.module中加入 js 1const options = new DocumentBuilder...中显示参数，则可以对参数设置一个类型，或是一个 Dto 模型。...js 1// user.dto.ts 2import { ApiProperty } from '@nestjs/swagger' 3import { 4 IsString, 5 IsNotEmpty...通过这种方式，可以少些很多判断类型的代码。实在是高。

2K2 0

学完这篇 Nest.js 实战，还没入门的来锤我！(长文预警)

说心里话，使用体验一般般，只能说还行首先安装一下： npm install @nestjs/swagger swagger-ui-express -S 我这里安装的版本是：5.1.4, 和4.x.x...接下来需要在main.ts中设置Swagger文档信息： ... import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async.../swagger'; import { Body, Controller, Delete, Get, Param, Post, Put, Query } from '@nestjs/common';...如果你想到这里，很好，说明你一直在思考，下面我们一边继续完善Swagger接口文档，一般解释这两点。...} from '@nestjs/swagger'; export class CreatePostDto { @ApiProperty({ description: '文章标题' }) readonly

17.6K7 6

重构kz-admin

依赖升级我原先的nestjs依赖是8.0.0，但是技术发展太快，nestjs 9.0.0都已经发布了，所以这次更新属于大版本更新，通常属于破坏性更新，可能会导致原代码失效，所以更新依赖要慎重。...既然都将nestjs更新了，那么nestjs相关生态的库自然也是要更新的，于是就遇到的typeorm 0.2.0 → 0.3.0用法的问题，主要是将findOne等方法改写，如 findOne(id)...整个过程还算顺利，使用ApiFox编写接口文档与接口测试在原项目中我Swagger写的其实够完善，但是在代码协同上只给前端一个Swagger地址不是很友好。...你可以访问 https://admin.kuizuo.cn/swagger-ui 来查看kz-admin的Swagger文档 json格式为https://admin.kuizuo.cn/swagger-ui...这里强烈建议将ApiFox接口问题，与nestjs的Swagger代码进行对比，就能体会到写好Swagger就能得到一份如此优雅的Api文档。做前端和做后端看到这文档，这不得发自内心的赞美。

2K1 0

Nest.js 实战 (四)：利用 Pipe 管道实现数据验证和转换

它使用 class-validator 库来检查数据是否符合定义在 DTOs 或请求模型上的验证规则 ParseIntPipe：将字符串类型的参数转换为整数 ParseFloatPipe：将字符串类型的参数转换为浮点数...：将传入的值转换为枚举类型中的成员 DefaultValuePipe：如果传入的参数是 undefined 或 null，则使用默认值替换它 ParseFilePipe：用于处理上传的文件，它可以验证文件的类型...types.includes(metatype); } } 3、 main.ts 中全局注册： import { NestFactory } from '@nestjs/core'; import.../swagger'; import { IsNotEmpty, IsNumber, IsOptional, IsUUID } from 'class-validator'; export class.../common'; import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger'; // swagger 接口文档 import

6471 0

学完这篇 Nest.js 实战，还没入门的来锤我！(长文预警)

说心里话，使用体验一般般，只能说还行首先安装一下： npm install @nestjs/swagger swagger-ui-express -S 复制代码我这里安装的版本是：5.1.4, 和...接下来需要在main.ts中设置Swagger文档信息： ... import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async.../swagger'; import { Body, Controller, Delete, Get, Param, Post, Put, Query } from '@nestjs/common';...如果你想到这里，很好，说明你一直在思考，下面我们一边继续完善Swagger接口文档，一般解释这两点。...} from '@nestjs/swagger'; export class CreatePostDto { @ApiProperty({ description: '文章标题' }) readonly

12.1K1 1

Nest.js 实战 (七)：如何生成 SVG 图形验证码

具体步骤 1、安装依赖 pnpm add svg-captcha 2、在控制器中使用 import { Controller, Get, Res, Session } from '@nestjs.../common'; import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger'; // swagger 接口文档 import...session.captchaCode = captcha.text; //使用session保存验证，用于登陆时验证 res.type('image/svg+xml'); //指定返回的类型

6441 0

【Nest教程】Nest项目配置http和https

; import * as https from 'https'; import * as express from 'express'; import { NestFactory } from '@nestjs..., } from '@nestjs/platform-express'; import { AppModule } from '..../swagger'; const httpsOptions = { ca: fs.readFileSync('/opt/nestjs-api/src/ssl/nmwap.com_chain.crt...'), key: fs.readFileSync('/opt/nestjs-api/src/ssl/nmwap.com.key'), cert: fs.readFileSync('/opt/nestjs-api...此方法带有两个参数，分别是应用程序实例和基本Swagger选项。

4K14 11

NestJS 7.x 折腾记: (3) 采用nestjs-pino作为Nest logger

# https://github.com/iamolegga/nestjs-pino yarn add nestjs-pino # pino 日志美化工具(用于开发模式美滋滋,看效果图的开发模式) yarn...{ HttpModule, Module } from '@nestjs/common'; import { AppController } from '..../app.service'; import { LoggerModule } from 'nestjs-pino'; import envReportConfig from '..../config/env/swagger.config'; import { getDirAllFileNameArr } from '....SWAGGER_UI_TITLE: Joi.string().default('Swagger文档标题'), SWAGGER_UI_TITLE_DESC: Joi.string

3.2K3 0

NestJS 7.x 折腾记: (5) 管道,一个好玩的东西!比如入参校验!

前言管道这个词,若是有玩过Linux的小伙伴肯定知晓,比如(看图): 意思就git的提交记录以单行显示的前三条,而且提交概要中有build这个词的在nest里面的管道,主要是用来做入参数据类型的拦截转换...其实官方教程写的挺好了, 局部管道和全局管道都写到了, 这里我们以更具通用性的入参全局管道做例子, 尽量写的更贴近业务和更为粗俗的解释吧~ 安装 # class-validator: 提供非常丰富的类型装饰器...throw new BadRequestException(`字段校验不通过: ${msg}`); } return value; } // 这个函数的意义就是验证元数据传入的类型是否是定义内的常规类型数据.../swagger'; import { IsInt, IsNumberString, IsOptional, IsString, Max, Min, } from 'class-validator.../swagger'; import { CreateAppDto, FindOneParams, UserRole } from '.

1.4K3 0

NestJS、TypeORM 和 PostgreSQL 项目开发和数据库迁移完整示例（译）

它是一个相当灵活的框架，建立在 Express.js 的基础上，可以让你在短时间内制作出 Node.js 服务，因为它集成了很多好功能（如完全的类型化支持、依赖注入、模块管理和更多）。...因此，您在代码中更改了实体类， typeORM 会为你自动同步字段，但是，一旦您的数据库中有实际数据，后期打算修改字段类型或其他操作时，TypeORM 将通过删除并重新创建数据库表来更改数据库，这意味着你极有可能丢失了表内的数据...这就是一个简单的服务和响应 DTO 的样子：注意：你必须为此安装 @nestjs/swagger、class-validator 和 class-transformer。...// item.dto.ts import { ApiModelProperty } from'@nestjs/swagger'; import { IsString, IsUUID, } from'class-validator...您只需安装： npm install --save @nestjs/swagger swagger-ui-express 并在 main.ts 中添加这几行 // main.ts asyncfunction

7.6K2 1

NestJS、TypeORM 和 PostgreSQL 项目开发和数据库迁移完整示例（译）

6K1 0

点击加载更多

NestJS 7.x 折腾记: (4) Swagger接入及相关用法

Nest.js 实战 (三)：使用 Swagger 优雅地生成 API 文档

Nest.js 从零到壹系列（七）：讨厌写文档，Swagger UI 了解一下？

基于Nest快速构建Web应用

Swagger + Nest.js：打通全栈之路，API 文档生成的秘籍

【Nest教程】集成Swagger自动生成接口文档

【Nest教程】实现一个简单的用户增删改查功能

Nest集成Swagger并部署至YAPI

NestJS 7.x 折腾记: (2) 环境变量及配置维护

从零开始的 Nest.js

学完这篇 Nest.js 实战，还没入门的来锤我！(长文预警)

重构kz-admin

Nest.js 实战 (四)：利用 Pipe 管道实现数据验证和转换

学完这篇 Nest.js 实战，还没入门的来锤我！(长文预警)

Nest.js 实战 (七)：如何生成 SVG 图形验证码

【Nest教程】Nest项目配置http和https

NestJS 7.x 折腾记: (3) 采用nestjs-pino作为Nest logger

NestJS 7.x 折腾记: (5) 管道,一个好玩的东西!比如入参校验!

NestJS、TypeORM 和 PostgreSQL 项目开发和数据库迁移完整示例（译）

NestJS、TypeORM 和 PostgreSQL 项目开发和数据库迁移完整示例（译）

相关资讯

热门标签

活动推荐

运营活动

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐