首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

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

现如今,前后台开发分离已成为一种标准,后台负责提供api,其余功能交给前台来实现,但是项目开发的沟通成本也随之提高,这部分成本主要体现在前台需要接口文档,但是后台可能没时间写或者其他原因,导致功能对接缓慢...1 安装Swagger yarn add @nestjs/swagger swagger-ui-express --save 2 配置Swagger 需要在src目录下main.ts文件配置及构建出口...此方法带有两个参数,分别是应用程序实例和基本Swagger选项。...此方法接收两个参数,即应用程序实例和 Swagger 选项对象。 一旦创建完文档,我们就可以调用 setup() 方法。...4 其他配置项 还提供很多配置项,ApiQuery、ApiBody、ApiParam、ApiHeader、ApiHeaders等,这里就不一一介绍了,有兴趣可以浏览官方文档: https://docs.nestjs.com

2.6K1411

重构kz-admin

想到后续项目的应用场景大概率也可能是多项目的,于是就准备使用 turborepo 将项目重构为 monorepo 管理,将前后端项目都统一放到一个仓库,并且将 nestjs 版本升级到 v9,顺便在完善一下...既然都将nestjs更新了,那么nestjs相关生态的库自然也是要更新的,于是就遇到的typeorm 0.2.0 → 0.3.0用法的问题,主要是将findOne等方法改写, findOne(id)...将操作动词后置,这样做好处就是不用从一堆CreatxxxxDto找一个CreateUserDto,而是转变成从几个UserxxxxDto找UserCreateDto,就像下图这样,左侧Swagger,...定义数据实体(Schemas)非常重要,这样我们就能知道该请求接口应该传递什么参数,会接收到什么样的数据。...这里强烈建议将ApiFox接口问题,与nestjsSwagger代码进行对比,就能体会到写好Swagger就能得到一份如此优雅的Api文档。 做前端和做后端看到这文档,这不得发自内心的赞美。

1.7K10

基于Nest快速构建Web应用

这里简单介绍一下什么是Nestjs Nestjs是一个用于构建高效且可伸缩的服务端应用程序的渐进式 Node.js 框架。...7.5.1 核心包 @nestjs/config 环境变量治理 @nestjs/swagger 生成接口文档 swagger-ui-express 装@nestjs/swagger 必装的包 处理接口文档样式...框架 @nestjs/typeorm nest typeorm 集成 ejs 模版引擎 class-validator 校验参数 ioredis redis 客户端 nestjs-redis nest...└─utils # 工具类 使用 开始开发 复制根目录下default.env文件,重命名为.env文件,修改其配置 yarn start:dev 开始开发 本地新建数据库,Redis,修改.env相关配置...= Fast-nest-temp 接口文档 SWAGGER_UI_TITLE_DESC = 接口文档 SWAGGER_API_VERSION = 0.0.1 SWAGGER_SETUP_PATH =

1.6K10

Nest集成Swagger并部署至YAPI

集成Swagger 首先,我们通过yarn安装三个依赖包,如下所示: yarn add @nestjs/swagger swagger-ui-express fastify-swagger 安装完成后.../swagger,它提供了丰富的依赖供我们使用, 为我们生成友好的接口文档,接下来我们列举几个较为常用的注解: @ApiTags注解,用于对controller层进行描述。...@ApiOperation注解,用于对controller的具体接口进行描述。 @ApiProperty注解,用于对dto层的参数进行描述。...我又抱着疑问打开了swagger-ui仓库,在docs/usage/installation.md[8]它讲述了原因,提供了webpack的配置方案。...image-20220318075453246 打开链接所指向的项目后,在webpack的配置文件我看到了copy-webpack-plugin插件,此时我茅塞顿开,它的做法就是将swagger-ui-dist

1.8K40

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

@Controller 每一个要成为控制器的类,都需要借助@Controller装饰器的装饰,该装饰器可以传入一个路径参数,作为访问这个控制器的主路径: 对app.controller.ts文件进行修改...说心里话, 使用体验一般般,只能说还行 首先安装一下: 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的优势之一就是,只要注解到位,可以精确展示每个字段的意义,我们想要对每个传入的参数进行说明。...对于第一个问题,我们都知道Typescript接口在编译过程是被删除的,其次后面我们要给参数加说明,使用Swagger的装饰器,interface也是无法实现的,比如: import { ApiProperty

12K42

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

它是一个相当灵活的框架,建立在 Express.js 的基础上,可以让你在短时间内制作出 Node.js 服务,因为它集成了很多好功能(完全的类型化支持、依赖注入、模块管理和更多)。...3000/item | jq [] # << indicating no items in the DB - cool :) 不要暴露你的实体 —— 添加 DTO 和响应 不要通过您的 API 向消费者公开您在持久性上的实际数据模型...这就是一个简单的服务和响应 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

6K21

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

@Controller 每一个要成为控制器的类,都需要借助@Controller装饰器的装饰,该装饰器可以传入一个路径参数,作为访问这个控制器的主路径: 对app.controller.ts文件进行修改...说心里话, 使用体验一般般,只能说还行 首先安装一下: npm install @nestjs/swagger swagger-ui-express -S 复制代码 我这里安装的版本是:5.1.4, 和...接下来需要在main.ts设置Swagger文档信息: ... import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async..., Swagger的优势之一就是,只要注解到位,可以精确展示每个字段的意义,我们想要对每个传入的参数进行说明。...对于第一个问题,我们都知道Typescript接口在编译过程是被删除的,其次后面我们要给参数加说明,使用Swagger的装饰器,interface也是无法实现的,比如: import { ApiProperty

9.2K11
领券