首页
学习
活动
专区
圈层
工具
发布

Nest集成Swagger并部署至YAPI

集成Swagger 首先,我们通过yarn安装三个依赖包,如下所示: yarn add @nestjs/swagger swagger-ui-express fastify-swagger 安装完成后...,我们打开项目的入口文件main.ts添加如下所示的代码: import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger"; async.../swagger库中,它提供了丰富的依赖供我们使用, 为我们生成友好的接口文档,接下来我们列举几个较为常用的注解: @ApiTags注解,用于对controller层进行描述。...-20220317224923516 ❝有关swagger注解的更多使用方法请移步:OpenAPI (Swagger)[4] 部署至服务器 接下来,我们要做的就是将项目打包部署到服务器了,本项目采用的是单文件构建法...image-20220318075453246 打开链接所指向的项目后,在webpack的配置文件中我看到了copy-webpack-plugin插件,此时我茅塞顿开,它的做法就是将swagger-ui-dist

2.1K40
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

    什么是 Swagger ? Swagger 是一组围绕 OpenAPI 规范构建的开源工具,可以帮助您设计、构建、记录和使用 REST API。...定义 Swagger Core:用于创建、使用和处理 OpenAPI 定义的 Java 相关库 Swagger Parser:用于解析 OpenAPI 定义的独立库 Swagger APIDom:提供了一个单一的...、统一的结构,用于跨各种描述语言和序列化格式描述 API Nest 集成 Swagger 1、 安装依赖 pnpm add @nestjs/swagger swagger-ui-express 2、...1、 在 DTO(响应数据传输对象) 文件中使用装饰器 import { ApiProperty } from '@nestjs/swagger'; import { IsNumberString,...: number; } 2、 在 Controller 控制器 中使用装饰器 import { Controller, Get, Query } from '@nestjs/common'; import

    1.2K11

    一个现代化协同文档编辑器,丰富的编辑能力与多人实时协作

    一、开源项目简介 DocFlow 一个基于 Tiptap 和 Next.js 构建的现代化协同文档编辑器,集成了丰富的编辑能力与多人实时协作功能,支持插件扩展、主题切换与持久化存储。...二、开源协议 使用MIT开源协议 本项目采用 MIT 开源协议发布,但包含部分 Tiptap Pro 模板代码除外。...支持多人实时协作编辑,让团队像使用 Google Docs 一样流畅协作,同时拥有强大的 AI 能力加持。...功能特性 富文本编辑:标题、列表、表格、代码块、数学公式、图片、拖拽等 实时协作:使用 Yjs + @hocuspocus/provider 实现高效协同 插件丰富:基于 Tiptap Pro 多种增强功能.../swagger 基于代码注解自动生成 Swagger UI 文档 安全中间件 @fastify/helmet, @fastify/rate-limit 添加 HTTP 安全头部、限制请求频率、防止暴力攻击等安全保护

    37810

    重构kz-admin

    kz-admin 使用 NestJs + TypeScript + TypeORM + Redis + MySql + Vben Admin 等技术栈,并采用 monorepo 管理项目,希望这个项目在...想到后续项目的应用场景大概率也可能是多项目的,于是就准备使用 turborepo 将项目重构为 monorepo 管理,将前后端项目都统一放到一个仓库中,并且将 nestjs 版本升级到 v9,顺便在完善一下...整个过程还算顺利, 使用ApiFox编写接口文档与接口测试​ 在原项目中我Swagger写的其实够完善,但是在代码协同上只给前端一个Swagger地址不是很友好。...这里强烈建议将ApiFox接口问题,与nestjs的Swagger代码进行对比,就能体会到写好Swagger就能得到一份如此优雅的Api文档。 做前端和做后端看到这文档,这不得发自内心的赞美。...但是Vben Admin仅仅只是前端模板与mock数据,并无后端数据,于是就正好利用我使用的 Node 后端框架 Nestjs 来编写后端服务。

    2K10

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

    为了使过程更健壮,我们将为 docker 容器使用相同的名称(脚本中的 $SERVER var),并添加一个额外的检查:如果有同名的容器正在运行,那么将结束并删除它以确保干净状态。...让我们使用预构建的 NestJS-to-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.6K21

    Github 火热的 FastAPI 库,站在了这些知名库的肩膀上

    首先,我尝试使用许多不同的框架,插件和工具来解决 FastAPI 涵盖的所有功能。...APISpec 可做为很多框架的插件(也是做为 Starlette 插件)。 它的工作方式是,在 Python 的文档字符串内部使用 YAML 格式的描述来为每一个函数自动生成文档。...NestJS (and Angular) 这很跟 Python 没有关系,NestJS是一个JavaScript(TypeScript)NodeJS 框架,受Angular 启发。...这是最早使用Python类型提示声明参数和请求的框架之一(在NestJS和Molten之前)。我在发现 Hub 框架的同时也发现了它。但是 APIStar 使用了OpenAPI 标准。...尽管他们正在这样做,但它仍然不是“ Python标准”(PEP)。但是,它已经被多种工具用作“标准”。

    6.1K30

    安全插件AIOS被曝明文记录密码!上百万用户正在使用!

    作者丨小王斯基 编辑丨zhuo Bleeping Computer 网站披露,超过百万 WordPress 网站使用的 All-In-One Security(AIOS)WordPress安全插件被曝将用户尝试登录的明文密码记录到网站数据库中...大约在三周前,一位用户反应 AIOS v5.1.9 插件不仅将用户尝试登录记录到 aiowps_audit_log 数据库表中,用于跟踪登录、注销和失败的登录事件,还记录了用了输入的密码。...一旦“恶意”网站管理员在用户可能使用相同密码的其他服务上尝试利用这些密码,此举会带来一些安全问题。...除了“恶意”管理员带来的安全风险外,使用 AIOS 的网站还将面临黑客入侵的风险,这些黑客一旦获得网站数据库访问权限,便有可能会以明文形式泄露用户密码。...最后,使用 AIOS 的网站应该尽快更新到最新版本,并要求用户重置密码。

    38940

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

    为了使过程更健壮,我们将为 docker 容器使用相同的名称(脚本中的 $SERVER var),并添加一个额外的检查:如果有同名的容器正在运行,那么将结束并删除它以确保干净状态。...让我们使用预构建的 NestJS-to-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

    6.4K30

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

    为了使过程更健壮,我们将为 docker 容器使用相同的名称(脚本中的 $SERVER var),并添加一个额外的检查:如果有同名的容器正在运行,那么将结束并删除它以确保干净状态。...让我们使用预构建的 NestJS-to-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

    6K10

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

    所以就出现了Sequelize、typeORM、Prisma这些ORM框架来做这个转换, (ps:Prisma呼声很高,喜欢探索的可以尝试婴一下)我们这里选择typeORM来操作数据库。..., 推荐使用官方提供的@nestjs/config,开箱即用。...我这里用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

    17.6K76

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

    所以就出现了Sequelize、typeORM、Prisma这些ORM框架来做这个转换, (ps:Prisma呼声很高,喜欢探索的可以尝试婴一下)我们这里选择typeORM来操作数据库。..., 推荐使用官方提供的@nestjs/config,开箱即用。...我这里用swagger,用它的原因一方面是 Nest.js提供了专用的模块来使用它,其次可以精确的展示每个字段意义,只要注解写的到位!...说心里话, 使用体验一般般,只能说还行 首先安装一下: npm install @nestjs/swagger swagger-ui-express -S 复制代码 我这里安装的版本是:5.1.4, 和...接下来需要在main.ts中设置Swagger文档信息: ... import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'; async

    12.1K11
    领券