NestJS Swagger -如何声明多选枚举字段？ - 腾讯云开发者社区

文章/答案/技术大牛

发布

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

- 覃超的回答 - 知乎[2] Swagger 之旅初始化 Swagger $ yarn add @nestjs/swagger swagger-ui-express -S 安装完依赖包后，只需要在...: string | number; } 保存，刷新页面（该页面没有热加载功能），再看看效果：看到已经有了字段信息了，但是我们的 role 字段是【可选】的，而文档中是【必填】的，接下来再完善一下描述...那么，如何在 Swagger 中登录呢？.../user.dto'; import { ApiTags, ApiBearerAuth } from '@nestjs/swagger'; @ApiBearerAuth() // Swagger 的...本篇只是抛砖引玉， Swagger UI 还有很多可配置的玩法，比如数组应该怎么写，枚举应该怎么弄，如何设置请求头等等，因为篇幅原因，就不在这里展开了。

5.3K1 0

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

前言 swagger这东东,萝卜青菜各有所爱吧. 反正我呆的公司用这个,我用的也还行! 有兴趣的可以瞅瞅~ 说说优点吧, 可以精确的展示每个字段意义,只要注解写的到位! schema也能正常读取!...yarn add @nestjs/swagger swagger-ui-express 配置抽离的环境变量(dev.local.env) # ------- Node服务相关 ------------...~~ 老规矩,从typescript声明入手~~~ import { INestApplication } from '@nestjs/common'; import { OpenAPIObject,.../config/env/swagger.config'; import { NestFactory } from '@nestjs/core'; import { ValidationPipe } from...: any[]; } import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; export enum UserRole

2K1 0

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

是的

没有找到

基于Nest快速构建Web应用

这里简单介绍一下什么是Nestjs Nestjs是一个用于构建高效且可伸缩的服务端应用程序的渐进式 Node.js 框架。...7.5.1 核心包 @nestjs/config 环境变量治理 @nestjs/swagger 生成接口文档 swagger-ui-express 装@nestjs/swagger 必装的包处理接口文档样式...account │ └─user ├─decorators # 装饰器 ├─dtos │ └─user ├─entities # 实体 ├─enum # 枚举...文档相关 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

nest.js 添加 swagger 响应数据文档

基本使用通常情况下，在 nest.js 的 swagger 页面文档中的响应数据文档默认如下此时要为这个控制器添加响应数据文档的话，只需要先声明数据的类型，然后通过@ApiResponse...要实现这种数据结构字段，首先定义一个自定义类用于包装，如 res.model.ts export class ResOp { @ApiProperty({ type: 'object.../common' import { ApiExtraModels, ApiResponse, getSchemaPath } from '@nestjs/swagger' import { ResOp...ref: getSchemaPath(ResOp) } 表示原始数据，要被“塞”到那个类下，而第二个参数 properties: { data: prop } 则表示 ResOp 的 data 属性要如何替换...，替换的部分则由 prop 变量决定，只需要根据实际需求构造相应的字段结构。

7962 0

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

Column({ 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

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.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';...} from '@nestjs/swagger'; export class CreatePostDto { @ApiProperty({ description: '文章标题' }) readonly

17.6K7 6

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

例如，如果您希望每个实体都拥有某些数据字段。例如：自动生成的 uuid id 字段和 createDateTime 字段，lastChangedDateTime 字段。...以下是如何设置 typeORM CLI 的最佳实践。...这就是一个简单的服务和响应 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 项目开发和数据库迁移完整示例（译）

6.4K3 0

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

6K1 0

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

我这里用swagger，用它的原因一方面是 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';...} from '@nestjs/swagger'; export class CreatePostDto { @ApiProperty({ description: '文章标题' }) readonly

12.1K1 1

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

# https://github.com/iamolegga/nestjs-pino yarn add nestjs-pino # pino 日志美化工具(用于开发模式美滋滋,看效果图的开发模式) yarn...还是同样的姿势,从typescript声明入手 import { DynamicModule } from "@nestjs/common"; import { LoggerModuleAsyncParams...: Params | undefined): DynamicModule; // 同步注册的方式,看下面参数声明 static forRootAsync(params: LoggerModuleAsyncParams.../config/env/swagger.config'; import { getDirAllFileNameArr } from '....SWAGGER_UI_TITLE: Joi.string().default('Swagger文档标题'), SWAGGER_UI_TITLE_DESC: Joi.string

3.2K3 0

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

：将字符串类型的参数转换为布尔值 ParseArrayPipe：将字符串形式的数组转换为数组 ParseUUIDPipe：解析字符串并验证是否为 UUID ParseEnumPipe：将传入的值转换为枚举类型中的成员...types.includes(metatype); } } 3、 main.ts 中全局注册： import { NestFactory } from '@nestjs/core'; import...app.listen(3000); } bootstrap(); 管道测试 1、假如我们现在有一个添加岗位的接口，它的 DTO 如下： import { ApiProperty } from '@nestjs.../swagger'; import { IsNotEmpty, IsNumber, IsOptional, IsUUID } from 'class-validator'; export class.../common'; import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger'; // swagger 接口文档 import

6511 0

从零开始的 Nest.js

Swagger 正是因为 nest 集成了 swagger 自动生成文档，我对他产生了非常好的影响。不用手动写文档，根据模型的字段和类型就能生成每个 api 的文档。简直不要太爽。...首先我们安装 swagger 对应的库。...1yarn add @nestjs/swagger swagger-ui-express COPY 在 app.module中加入 js 1const options = new DocumentBuilder...await this.masterService.createMaster() 5 } COPY js 1// user.dto.ts 2import { ApiProperty } from '@nestjs...js 1// user.dto.ts 2import { ApiProperty } from '@nestjs/swagger' 3import { 4 IsString, 5 IsNotEmpty

2K2 0

Nest.js 实战 (一)：使用过滤器优雅地统一处理响应体

业务数据 code: number; // 状态码 msg: string; // 响应信息 timestamp: number; // 时间戳 } 那么在 Nest.js 中，我们应该如何处理呢...定义响应状态码枚举和类型 1、在 src 目录中新建 /enums/index.ts 文件： /** * @description: 响应码 */ export enum RESPONSE_CODE...在 src 目录中新建 /dto/response.dto.ts 文件： import { ApiProperty } from '@nestjs/swagger'; import { RESPONSE_CODE...http-exception.filter.ts 文件： import { ArgumentsHost, Catch, ExceptionFilter, HttpException } from '@nestjs...import { NestFactory } from '@nestjs/core'; import { AppModule } from '.

7191 0

【Nest教程】Nest项目集成JWT接口认证

Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准（(RFC 7519).该token被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO...JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源，也可以增加一些额外的其它业务逻辑所必须的声明信息，该token也可直接被用于认证，也可被加密。.../passport @nestjs/jwt -S 4 创建Auth模块 src下新建文件夹logical/auth，auth目录下为我们逻辑功能。.../user/user.module'; import { PassportModule } from '@nestjs/passport'; import { JwtModule } from '@nestjs.../swagger'; import { Controller, Post, Body, Logger, HttpCode, UseGuards, } from '@nestjs/

3.3K13 11

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

文档自动生成：根据API定义自动生成交互式API文档，让前端开发和测试人员能够了解如何使用API，通常通过Swagger UI来展示。...安装依赖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 '....访问接口文档通过该 URL 来访问接口文档 http://localhost:3000/docs/ 最后在这篇文章里，咱们一起走过了如何使用 Swagger 在 Nest.js 项目中构建那些帅气的接口文档

5350 0

使用NestJS搭建服务端应用

安装nest依赖包我们打开刚才创建的package.json文件，添加如下所示的字段： { "dependencies": { "@nestjs/common": "^8.1.1",...private readonly appService: AppService) {} @Post("setTitle") setTitle(){ // 此处省略了较多代码，这里的重点是演示如何调用我们刚才写好的方法...举个例子，我们需要在声明5个方法，分别如下所示： getTitle getName getAge setName setTitle 实现代码在TypeScript中用interface关键字来声明一个接口...封装工具类我们在src目录下创建VO文件夹，在其目录下创建ResultVO.ts文件，代码如下所示：简单创建了一个类，添加了三个字段为每个字段写了get和set方法 export class ResultVO...那么，当我们把这些数据统一在枚举层进行定义，在业务代码中直接使用我们定义好的枚举，这个问题就迎刃而解了。

2.4K4 0

kz-admin后台管理系统

基于NestJs + TypeScript + TypeORM + Redis + MySql + Vben Admin编写的一款前后端分离的权限管理系统演示地址：KzAdmin 管理员账号：admin...项目存放svg图片的文件夹 │ ├── components # 公共组件 │ ├── design # 样式文件 │ ├── directives # 指令 │ ├── enums # 枚举...数据库中的 menu 表如下对于主要字段介绍： parent：对于有父子关系的表，会创建一个 parent_id(这里为 parent)字段用于表示父节点，无则为顶级节点。...其他文档你可以访问 https://admin.kuizuo.cn/swagger-ui 来查看kz-admin的Swagger文档 json格式为 https://admin.kuizuo.cn/...swagger-ui/json，用于导入ApiFox中。

2.4K2 0

JAVA中自定义扩展Swagger的能力，自动通过枚举类生成参数取值含义描述的实现策略

扩展可行性分析既然想要改变生成的Swagger文档中指定字段的描述内容，那么首先就应该是要搞清楚Swagger中现在的内容生成逻辑是如何处理的。我们以@ApiParam为例进行分析。...现在又遇到一个问题，枚举类的实现形式其实也不一样，要如何才能让我们的自动内容生成服务知道获取枚举类中的哪些内容进行处理呢？...先来看下面给定的这个枚举类，其中包含order、value、desc三个属性值，而value字段是我们的接口字段需要传入的真实取值，desc是其对应的含义描述，那么该如何让我们自定义Swagger扩展类知晓应该使用...@SwaggerDisplayEnum并指定下字段的映射，即可用于Swagger注解中：到这里呢，我们需要的数据来源以及取值转换规则就已经全部确定，剩下的就是如何将一个枚举类中需要的值与描述字段给拼接成想要的内容了...总结好啦，关于如何通过自定义注解的方式扩展Swagger的能力让Swagger支持自动从指定的枚举类生成接口文档中的字段描述的实现思路，这里就给大家分享到这里啦。

4.7K4 0

点击加载更多

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

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

基于Nest快速构建Web应用

nest.js 添加 swagger 响应数据文档

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

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

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

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

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

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

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

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

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

从零开始的 Nest.js

Nest.js 实战 (一)：使用过滤器优雅地统一处理响应体

【Nest教程】Nest项目集成JWT接口认证

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

使用NestJS搭建服务端应用

kz-admin后台管理系统

JAVA中自定义扩展Swagger的能力，自动通过枚举类生成参数取值含义描述的实现策略

相关资讯

热门标签

活动推荐

运营活动

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐