首页
学习
活动
专区
圈层
工具
发布
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

    /swagger swagger-ui-express 2、 在 main.ts 文件中定义并初始化 SwaggerModule 类 import { NestFactory } from '@nestjs...setTermsOfService 文档服务条款 setContact 文档联系信息 setLicense 文档许可证信息 addServer 文档服务地址 setExternalDoc 文档外部链接 setBasePath 设置文档基础路径...,用于组织 Swagger UI 文档 @ApiOperation 为控制器方法添加操作描述,包括摘要和详细描述 @ApiParam 描述路径参数、请求参数或响应参数,包括名称、类型、描述等 @ApiBody...为 DTO 类型的属性添加元数据,如描述、默认值等 @ApiQuery 描述查询参数,包括名称、类型、描述等 @ApiHeader 描述请求头信息,包括名称、类型、描述等 @ApiExcludeEndpoint...标记一个控制器方法不在 Swagger UI 中显示 效果图 总结 在 Nest 中集成 Swagger 文档可以帮助开发者自动生成和维护 API 文档,Swagger 的集成提供了在线生成、‌自动生成

    97411

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

    在 Nest.js 中,管道(Pipelines) 是一种强大的功能,用于预处理进入控制器方法的请求数据,如请求体、查询参数、路径参数等。...以下是 Nest.js 中管道的一些主要用途: 数据转换:管道如 ParseIntPipe、ParseFloatPipe、ParseArrayPipe 等可以将原始输入数据转换为应用内部所需的类型,如将字符串转换为整数或浮点数...将字符串类型的参数转换为浮点数 ParseBoolPipe:将字符串类型的参数转换为布尔值 ParseArrayPipe:将字符串形式的数组转换为数组 ParseUUIDPipe:解析字符串并验证是否为...types.includes(metatype); } } 3、 main.ts 中全局注册: import { NestFactory } from '@nestjs/core'; import...} from '@nestjs/common'; import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger'; // swagger

    53410

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

    这里要提一个关于路由匹配时的注意点, 当我们有一个put请求,路径为/app/list/user,此时,我们在app.controller.ts控制器文件中增加一个方法: @Put("list/user.../config/env'; @Module({ imports: [ ConfigModule.forRoot({ isGlobal: true, // 设置为全局 envFilePath...id){ return await this.postsService.remove(id) } } 操作数据库踩过的坑 实体的强替换,莫名其妙的删表,清空数据 以我们上面设置的实体为例...接下来需要在main.ts中设置Swagger文档信息: ... import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async...} from '@nestjs/swagger'; export class CreatePostDto { @ApiProperty({ description: '文章标题' }) readonly

    16.2K76

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

    这里要提一个关于路由匹配时的注意点, 当我们有一个put请求,路径为/app/list/user,此时,我们在app.controller.ts控制器文件中增加一个方法: @Put("list/user.../config/env'; @Module({ imports: [ ConfigModule.forRoot({ isGlobal: true, // 设置为全局 envFilePath...{ return await this.postsService.remove(id) } } 复制代码 操作数据库踩过的坑 实体的强替换,莫名其妙的删表,清空数据 以我们上面设置的实体为例...接下来需要在main.ts中设置Swagger文档信息: ... import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async...} from '@nestjs/swagger'; export class CreatePostDto { @ApiProperty({ description: '文章标题' }) readonly

    11.8K11

    如何通过Dockerfile优化Nestjs构建镜像大小

    原文开始这是一篇手把手的教程,教你如何在制作nestjs镜像时,能够编写出一个优化生产依赖的Dockerfile有了这个Dockerfile,无论是在本地开发环境,还是在容器环境都能很轻松完成部署P.S...复制代码把一下文件给排除忽略掉Dockerfile.dockerignorenode_modulesnpm-debug.logdist复制代码在本地测试下如果你在本地安装了docker,可以在本地进行打包测试,让我们来瞧瞧是否如预期中那样打包镜像在命令行中执行以下命令...添加 NODE_ENV 环境变量很多依赖包会根据当前的NODE_ENV环境变量而进行判断是否优化压缩,所以我们可以在Dockerfile里面把环境变量加进去,设置为productionENV NODE_ENV...production复制代码顺便提一句,如果你不知道如何在Nestjs里面通过配置文件进行环境变量设置的话,可以看下这篇入门文章www.tomray.dev/nestjs-conf…使用npm ci...应用,可以把前两个阶段合二为一上述多阶段设置的好处在于,这样你就有了一个可以在本地开发中使用的Dockerfile(与docker-compose组合在一起)。

    2.8K40

    学习NestJS的第一个接口(一)

    下面我们主要介绍下NestJS NestJS 具有架构设计合理、功能特性丰富、开发效率高、性能和可扩展性好等优势,是构建 Node.js 服务器端应用程序的理想选择 一、架构设计 1.模块化架构 NestJS...二、功能特性 1.支持多种后端技术 NestJS 可以与多种后端技术集成,如 TypeScript、Express.js、Fastify 等。...3.支持微服务架构 NestJS 支持构建微服务架构,可以轻松地将应用程序拆分为多个独立的服务,每个服务可以独立部署和扩展。这使得应用程序具有更好的可扩展性和高可用性。...3.与前端框架集成方便 NestJS 可以与各种前端框架(如 Angular、React、Vue.js 等)集成,实现前后端分离的开发模式。...后续还会写NestJS使用ORM、如何在NestJS中添加日志、jwt token处理、全局错误处理、接口参数校验、redis缓存、图片上传等等

    89020

    在NestJS中配置微服务:初学者指南

    在 2011 年之前,单体架构是后端开发的主要方法。在这种模型中,整个应用程序被构建为一个单一的、统一的代码库,其中所有组件和服务紧密耦合,并作为一个模块一起部署。...技术灵活性: 在微服务架构中,每个服务可以使用最适合其特定需求的技术、语言或框架进行开发。这种灵活性允许开发团队为每个任务选择最佳工具。...与之相反,微服务架构通过引入应用程序网关增加了额外的复杂性。应用程序网关在微服务设置中充当至关重要的中间层。以下是它的工作原理: 请求处理: 网关接收来自客户端的所有传入请求。...在此过程中,我将介绍设置微服务架构、管理依赖项和保护部署的最佳实践,为构建健壮高效的分布式系统奠定坚实的基础。 设置基础 NestJS 应用程序 在开始之前,请确保已安装 Node.js。...您已经成功地完成了使用 NestJS、Prisma、MySQL 和 NATS 配置健壮的微服务架构的复杂过程。虽然您已经成功地设置了功能性的微服务架构,但始终有改进的空间。

    92410

    Nest.js 实战 (十二):优雅地使用事件发布订阅模块 Event Emitter

    @nestjs/event-emitter 是一个 Nest.js 的社区模块,基于强大的 eventemitter2 库,它提供了事件发布/订阅的功能,使得在 Nest.js 应用程序中实现事件驱动架构变得简单...超过此数量时,将抛出警告 captureRejections: true, // 是否捕获异步函数的拒绝(rejection)。...如果设置为 true,则会在事件处理函数中捕获 Promise.reject wrapEmitters: true, // 是否包装事件发射器。...如果设置为 true,那么所有的事件发射器都会被包装,以提供更多的功能 ignoreErrors: true, // 当事件处理过程中出现错误时,是否忽略这些错误。...如果设置为 true,则不会抛出错误,而是会被忽略 }), ], }) export class AppModule {} 通过这些配置选项,你可以根据自己的需求定制事件发布/订阅的行为,使其更符合你的应用程序的具体要求

    48410

    NestJS学习总结篇

    Get传值或者Post提交的数据的话我们可以使用Nestjs中的装饰器来获取。...exports 由本模块提供并应在其他模块中可用的提供者的子集 // 创建模块 posts nest g module posts Nestjs中的共享模块 每个模块都是一个共享模块。...cookoe后失效 httpOnly Boolean 默认为false 如果为true表示不允许客户端(通过js来获取cookie) maxAge String 最大失效时间(毫秒),设置在多少时间后失效...path String 表示cookie影响到的路径,如:path=/如果路径不能匹配的时候,浏览器则不发送这个cookie secure Boolean 当 secure 值为 true 时,cookie...在 HTTP 中是无效,在 HTTPS 中才有效 signed Boolean 表示是否签名cookie,如果设置为true的时候表示对这个cookie签名了,这样就需要用res.signedCookies

    2.8K42

    在NestJS应用程序中使用 Unleash 实现功能切换的指南

    对于使用 NestJS 框架构建的应用程序而言,实现功能开关也是一项重要的任务。而 Unleash 是一个功能切换服务,它提供了一种简单且可扩展的方式来管理和控制应用程序的功能切换。...因此本文小编将为大家介绍如何在 NestJS 应用程序中使用 Unleash 实现功能切换。...下面是具体的操作步骤: 安装 NestJS NestJS 的安装非常简单,在安装之前需要确保你的机器中已经安装了 Node,然后执行以下命令即可在全局安装 NestJS。...yarn add unleash-client @nestjs/config 然后在项目的根目录中添加一个 .env 文件。...创建功能切换后,前往项目设置并创建项目访问令牌(创建服务器端访问令牌)。

    59140
    领券