[pull] next from 142vip:next

.vitepress/sidebar.ts

@@ -2,13 +2,13 @@ import type { SidebarConfig, VipPackageJSON, VipProject } from '@142vip/vitepres
 import { defineVipSidebarConfig } from '@142vip/vitepress'
 
 enum ProjectId {
-  BUSINESS = '商业代码',
+  BUSINESS = '商业模块',
   TOOLS = '通用工具',
   EGG = 'Egg.js框架',
   NEST = 'Nest.js框架',
   BLOG = '博客工具',
   INFRA = '工程化',
-  DEMO = '演示Demo',
+  DEMO = '最佳实践',
 }
 
 /**
@@ -21,6 +21,15 @@ export const sidebarConfig = defineVipSidebarConfig([
       { text: '@142vip/data-source', link: '/packages/data-source/index.md' },
     ],
   },
+  {
+    text: `🎮 ${ProjectId.DEMO}`,
+    items: [
+      { text: 'egg-demo', link: '/apps/egg-demo/index.md' },
+      { text: 'nest-demo', link: '/apps/nest-demo/index.md' },
+      { text: 'vitepress-demo', link: '/apps/vitepress-demo/index.md' },
+      { text: 'vuepress-demo', link: '/apps/vuepress-demo/index.md' },
+    ],
+  },
   {
     text: `🏆 ${ProjectId.INFRA}`,
     items: [
@@ -75,15 +84,6 @@ export const sidebarConfig = defineVipSidebarConfig([
       { text: '@142vip/vuepress', link: '/packages/vuepress/index.md' },
     ],
   },
-  {
-    text: `🎮 ${ProjectId.DEMO}`,
-    items: [
-      { text: 'egg-demo', link: '/apps/egg-demo/index.md' },
-      { text: 'nest-demo', link: '/apps/nest-demo/index.md' },
-      { text: 'vitepress-demo', link: '/apps/vitepress-demo/index.md' },
-      { text: 'vuepress-demo', link: '/apps/vuepress-demo/index.md' },
-    ],
-  },
 ])
 
 /**

apps/nest-demo/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## v0.0.1-alpha.4 (2026-01-21)
+
+### ✨ Features
+
+- 简化示例代码，降低基础模块学习成本 &nbsp;-&nbsp; by **chufan** [<samp>(7779b)</samp>](https://github.com/142vip/core-x/commit/7779b50c)
+
+**Release New Version v0.0.1-alpha.4 [👉 View New Package On NPM](https://www.npmjs.com/package/nest-demo)**
+
+## v0.0.1-alpha.3 (2026-01-06)
+
+### 🐛 Bug Fixes
+
+- 修复`GET`接口参数异常 &nbsp;-&nbsp; by **chufan** [<samp>(bf521)</samp>](https://github.com/142vip/core-x/commit/bf5217f1)
+
+**Release New Version v0.0.1-alpha.3 [👉 View New Package On NPM](https://www.npmjs.com/package/nest-demo)**
+
+## v0.0.1-alpha.2 (2026-01-05)
+
+### ✨ Features
+
+- 补充typeorm实战实践，简化通用配置和依赖 &nbsp;-&nbsp; by **chufan** [<samp>(bdd7e)</samp>](https://github.com/142vip/core-x/commit/bdd7e7f4)
+
+**Release New Version v0.0.1-alpha.2 [👉 View New Package On NPM](https://www.npmjs.com/package/nest-demo)**
+
 ## v0.0.1-alpha.1 (2025-11-04)
 
 ### ✨ Features

apps/nest-demo/config/test.config.js

@@ -2,9 +2,34 @@ module.exports = {
   starter: {
     port: 3000,
     enableSwagger: true,
-    swagger: {},
-    // logger: {},
+    globalPrefix: '/api/example',
+    swagger: {
+      // docPath: '/doc',
+      // envs: {
+      //   local: 'http://127.0.0.1',
+      // },
+      // builderOptions: {
+      //   globalResponses: [
+      //     {
+      //       status: 500,
+      //       description: '服务异常',
+      //     },
+      //     {
+      //       status: 400,
+      //       description: '参数错误',
+      //     },
+      //   ],
+      // },
+    },
+    redis: {
+      url: 'redis://127.0.0.1:6379',
+    },
+    typeorm: {
+      url: 'postgres://root:123456@127.0.0.1:5432/oauth-service',
+      synchronize: false,
+      logging: 'true',
+    },
     enableLogger: true,
+    // enableSwagger: true,
   },
-  test: 1,
 }

apps/nest-demo/nest-cli.json

@@ -3,6 +3,21 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@nestjs/swagger",
+        "options": {
+          "classValidatorShim": true,
+          "introspectComments": true,
+          "skipAutoHttpCode": false,
+          "dtoFileNameSuffix": [
+            ".dto.ts",
+            ".vo.ts",
+            ".entity.ts"
+          ]
+        }
+      }
+    ],
     "deleteOutDir": true
   }
 }

apps/nest-demo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nest-demo",
-  "version": "0.0.1-alpha.1",
+  "version": "0.0.1-alpha.4",
   "private": true,
   "description": "@142vip/nest相关包和插件的使用Demo",
   "authorInfo": {
@@ -16,11 +16,7 @@
     "build": "nest build",
     "start": "nest start"
   },
-  "peerDependencies": {
-    "@142vip/nest": "workspace:*"
-  },
   "dependencies": {
-    "@142vip/nest-redis": "workspace:*",
     "@142vip/nest-starter": "workspace:*"
   }
 }

apps/nest-demo/src/app.module.ts

@@ -1,17 +1,15 @@
-import { NestRedisModule } from '@142vip/nest-redis'
 import { Module } from '@nestjs/common'
 import { ConfigExampleModule } from './config-example/config-example.module'
 import { RedisExampleModule } from './redis-example/redis-example.module'
+import { RestExampleModule } from './rest-example/rest-example.module'
+import { TypeormExampleModule } from './typeorm-example/typeorm-example.module'
 
 @Module({
   imports: [
-    // 全局模块
-    NestRedisModule.register({ url: 'redis://172.16.202.252:6379' }),
-
-    // 最佳实践
+    TypeormExampleModule,
     RedisExampleModule,
-
     ConfigExampleModule,
+    RestExampleModule,
   ],
 })
 export class AppModule {}

apps/nest-demo/src/config-example/config-example.controller.ts

@@ -1,15 +1,24 @@
-import { StarterConfig } from '@142vip/nest-starter'
+import { ApiResponseSkip } from '@142vip/nest'
 import { Controller, Get } from '@nestjs/common'
+import { ApiTags } from '@nestjs/swagger'
 import { ConfigExampleService } from './config-example.service'
 
+/**
+ * 配置
+ */
 @Controller('config-example')
+@ApiTags('config')
 export class ConfigExampleController {
   constructor(
     private readonly configExampleService: ConfigExampleService,
   ) {}
 
+  /**
+   * 获取配置
+   */
   @Get('/')
-  public 'Get /'(): StarterConfig {
+  @ApiResponseSkip()
+  public 'Get /'() {
     return this.configExampleService.getStarterConfig()
   }
 }

apps/nest-demo/src/config-example/config-example.service.ts

@@ -1,5 +1,7 @@
 import { StarterConfig } from '@142vip/nest-starter'
+import { Injectable } from '@nestjs/common'
 
+@Injectable()
 export class ConfigExampleService {
   constructor(
     private readonly starterConfig: StarterConfig,

apps/nest-demo/src/config.ts

@@ -1,7 +1,8 @@
 import { NestAppConfig } from '@142vip/nest-starter'
-import { IsNumber } from 'class-validator'
 
+/**
+ * 配置
+ */
 export class Config extends NestAppConfig {
-  @IsNumber()
-  test!: number
+
 }

apps/nest-demo/src/redis-example/redis-example.controller.ts

@@ -1,23 +1,38 @@
+import { ApiResponseNull, ApiResponseSkip } from '@142vip/nest'
 import { Controller, Delete, Get, Post } from '@nestjs/common'
+import { ApiTags } from '@nestjs/swagger'
 import { RedisExampleService } from './redis-example.service'
 
 @Controller('redis-example')
+@ApiTags('redis')
 export class RedisExampleController {
   constructor(
     private readonly redisExampleService: RedisExampleService,
   ) {}
 
+  /**
+   * 创建
+   */
   @Post('/')
+  @ApiResponseNull()
   public async 'Post /'(): Promise<void> {
     await this.redisExampleService.setKey()
   }
 
+  /**
+   * 获取 所有缓存Key
+   */
   @Get('/')
+  @ApiResponseSkip()
   public async 'Get /'(): Promise<string | null> {
     return await this.redisExampleService.getKey()
   }
 
+  /**
+   * 删除
+   */
   @Delete('/')
+  @ApiResponseNull()
   public async 'Delete /'(): Promise<void> {
     await this.redisExampleService.delKey()
   }

apps/nest-demo/src/redis-example/redis-example.service.ts

@@ -7,7 +7,7 @@ const storeExample = { key: 'test', value: 'redis-example' }
 export class RedisExampleService {
   constructor(
     private readonly redisService: RedisService,
-  ) { }
+  ) {}
 
   async setKey(): Promise<void> {
     await this.redisService.setEx(storeExample.key, storeExample.value, 5)

apps/nest-demo/src/rest-example/rest-example.controller.ts

@@ -0,0 +1,76 @@
+import { ApiResponseNull, ApiResponseObject, ApiResponsePagination, PaginationResponse } from '@142vip/nest'
+import { Body, Controller, Delete, Get, Patch, Post, Query } from '@nestjs/common'
+import { ApiTags } from '@nestjs/swagger'
+import {
+  CreateRestExampleDTO,
+  GetRestExampleDTO,
+  GetRestExampleListDTO,
+} from './rest-example.dto'
+import { RestExampleService } from './rest-example.service'
+import { GetRestExampleListVo, GetRestExampleVo } from './rest-example.vo'
+
+@Controller('rest-example')
+@ApiTags('rest')
+export class RestExampleController {
+  constructor(
+    private readonly restExampleService: RestExampleService,
+  ) {}
+
+  /**
+   * 创建
+   */
+  @Post('/')
+  @ApiResponseNull()
+  public 'Post /'(
+    @Body() _params: CreateRestExampleDTO,
+  ): void {
+
+  }
+
+  /**
+   * 获取 - 单页
+   */
+  @Get('/')
+  @ApiResponseObject(GetRestExampleVo)
+  public async 'Get /'(
+    @Query() _params: GetRestExampleDTO,
+  ): Promise<GetRestExampleVo> {
+    const example = this.restExampleService.getExample()
+    return new GetRestExampleVo(example)
+  }
+
+  /**
+   * 获取 - 列表
+   */
+  @Get('/list')
+  @ApiResponsePagination(GetRestExampleListVo)
+  public async 'Get /list'(
+    @Query() params: GetRestExampleListDTO,
+  ): Promise<PaginationResponse<GetRestExampleListVo>> {
+    const examples = this.restExampleService.getExampleList()
+    return {
+      total: 1,
+      records: examples,
+      pageNum: params.pageNum,
+      pageSize: params.pageSize,
+    }
+  }
+
+  /**
+   * 更新
+   */
+  @Patch('/')
+  @ApiResponseNull()
+  public 'Patch /'(): void {
+
+  }
+
+  /**
+   * 删除
+   */
+  @Delete()
+  @ApiResponseNull()
+  public 'Delete /'(): void {
+
+  }
+}