nestjs+mysql+prisma + swagger项目搭建

nestjs 学习（一）

项目地址

1. 基础操作

1. 安装nest yarn add -g @nestjs/cli
2. 创建项目 nest new project-name
3. 启动服务器yarn run start
yarn start:dev 监听文件变化，自动重启服务
4. 使用nest-cli快速创建service/controller, 会自动引入Module中
   nest g [文件类型] [文件名] [文件目录（src目录下）]
   详细过程可以参考nest详细入门使用教程

2. 数据库的连接及使用——Mysql+Primsa

1. mysql 的基础知识点

官网下载安装，具体步骤可参考菜鸟教程
【常见基本命令】

  - mysql -u root -p //登陆本地mysql 的root账号， -p表示要输入密码
  > show databases; //展示所有的数据库
  > show tables; //展示所有的表
  > create database databaseName; //创建数据库

2. Prisma

基于nestjs和typescript的ORM

1. 安装 yarn add -D prisma
2. 项目 init - 生成配置文件/prisma/schema.prisma
npx prisma init （npx 是npm 的一个包执行器）
3. 配置schema.prisma，主要包括以下三方面：
   1. DB 连接的配置
   2. Prisma Client 配置
   3. data model 定义

datasource db {
  provider = "mysql". //哪种数据库
  url      = "file:dev.db" //数据库url
}

generator client {
  provider = "prisma-client-js"
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

4.运行prisma migrate 生成数据表和 client：
npx prisma migrate dev --name init
- ps: 如果后续有修改schema.prisma ，那么需要重新生成数据表和client
npx prisma migrate dev --name change

5.使用 client 对数据库进行 CRUD
6.使用 Prisma Studio GUI 查看并操作数据库
npx prisma studio

3. prisma 连接数据库和nest

1. 创建prisma 的module文件

import { Module, Global } from '@nestjs/common';
import { PrismaService } from './prisma.service';

@Global() // 定义全局之后，任何模块都可以直接使用prismaService
@Module({
  providers: [PrismaService],
  exports: [PrismaService],
})
export class PrismaModule {}

2. 创建prisma的service文件

import { Injectable, INestApplication } from '@nestjs/common';
import { PrismaClient } from '@prisma/client';

@Injectable()
export class PrismaService extends PrismaClient {
  async enableShutdownHooks(app: INestApplication) {
    this.$on('beforeExit', async () => {
      await app.close();
    });
  }
}

4. swagger

swagger： 一种基于RESTApi的工具，可生成交互式的api 文档

1. 安装 yarn add @nestjs/swagger swagger-ui-express
2. 在main.js 中引入swagger

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const swaggerConfig = new DocumentBuilder()
    .setTitle('swaggerLearn')
    .setDescription('The Nest Api document')
    .build();
  const document = SwaggerModule.createDocument(app, swaggerConfig);
  SwaggerModule.setup('api', app, document);

  await app.listen(8090);
}
bootstrap();

访问http://localhost:8090/api 就可以看到生成的api 文档

1. https://juejin.cn/post/6844904096017678343
2. https://juejin.cn/post/7112694027212259364