create-skweb 3.0.1 → 3.1.0

package/templates/cjs/src/controllers/user.js

@@ -3,99 +3,212 @@ const { db } = require('../services/database.js')
 
 const { SysUser } = db.sequelize.models
 
-module.exports = [
-  {
-    method: 'get',
-    path: '/api/users',
-    async handler(req) {
-      const { page = 1, limit = 10 } = req.query
-      const users = await SysUser.findAndCountAll({
-        offset: (Number(page) - 1) * Number(limit),
-        limit: Number(limit)
-      })
-      return {
-        list: users.rows,
-        total: users.count
-      }
+/**
+ * @swagger
+ * /api/users:
+ *   get:
+ *     summary: 获取用户列表
+ *     tags: [Users]
+ *     parameters:
+ *       - in: query
+ *         name: page
+ *         schema: { type: integer, minimum: 1, default: 1 }
+ *         description: 页码
+ *       - in: query
+ *         name: limit
+ *         schema: { type: integer, minimum: 1, default: 10 }
+ *         description: 每页条数
+ *     responses:
+ *       200:
+ *         description: OK
+ */
+const userList = {
+  method: 'get',
+  path: '/api/users',
+  async handler(req) {
+    const { page = 1, limit = 10 } = req.query
+    const users = await SysUser.findAndCountAll({
+      offset: (Number(page) - 1) * Number(limit),
+      limit: Number(limit)
+    })
+    return {
+      list: users.rows,
+      total: users.count
     }
+  }
+}
+
+/**
+ * @swagger
+ * /api/users/{id}:
+ *   get:
+ *     summary: 获取单个用户
+ *     tags: [Users]
+ *     parameters:
+ *       - in: path
+ *         name: id
+ *         required: true
+ *         schema: { type: integer, minimum: 1 }
+ *     responses:
+ *       200:
+ *         description: OK
+ *       404:
+ *         description: 用户不存在
+ */
+const userGet = {
+  method: 'get',
+  path: '/api/users/:id',
+  paramsSchema: {
+    type: 'object',
+    required: ['id'],
+    properties: { id: { type: 'integer', minimum: 1 } }
   },
-  {
-    method: 'get',
-    path: '/api/users/:id',
-    paramsSchema: {
-      type: 'object',
-      required: ['id'],
-      properties: { id: { type: 'integer', minimum: 1 } }
-    },
-    async handler(req) {
-      const { id } = req.validatedParams
-      const user = await SysUser.findByPk(id)
-      if (!user) {
-        throw new createHttpError.NotFound('User not found')
-      }
-      return user
+  async handler(req) {
+    const { id } = req.validatedParams
+    const user = await SysUser.findByPk(id)
+    if (!user) {
+      throw new createHttpError.NotFound('User not found')
+    }
+    return user
+  }
+}
+
+/**
+ * @swagger
+ * /api/users:
+ *   post:
+ *     summary: 创建用户
+ *     tags: [Users]
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required: [username, password]
+ *             properties:
+ *               username: { type: string, minLength: 3 }
+ *               password: { type: string, minLength: 6 }
+ *               email:    { type: string, format: email }
+ *               phone:    { type: string }
+ *     responses:
+ *       200:
+ *         description: 创建成功
+ */
+const userCreate = {
+  method: 'post',
+  path: '/api/users',
+  bodySchema: {
+    type: 'object',
+    required: ['username', 'password'],
+    properties: {
+      username: { type: 'string', minLength: 3 },
+      password: { type: 'string', minLength: 6 },
+      email: { type: 'string', format: 'email' },
+      phone: { type: 'string' }
     }
   },
-  {
-    method: 'post',
-    path: '/api/users',
-    bodySchema: {
-      type: 'object',
-      required: ['username', 'password'],
-      properties: {
-        username: { type: 'string', minLength: 3 },
-        password: { type: 'string', minLength: 6 },
-        email: { type: 'string', format: 'email' },
-        phone: { type: 'string' }
-      }
-    },
-    async handler(req) {
-      return await SysUser.create(req.validatedBody)
+  async handler(req) {
+    return await SysUser.create(req.validatedBody)
+  }
+}
+
+/**
+ * @swagger
+ * /api/users/{id}:
+ *   put:
+ *     summary: 更新用户
+ *     tags: [Users]
+ *     parameters:
+ *       - in: path
+ *         name: id
+ *         required: true
+ *         schema: { type: integer, minimum: 1 }
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               password: { type: string, minLength: 6 }
+ *               email:    { type: string, format: email }
+ *               phone:    { type: string }
+ *               status:   { type: integer }
+ *     responses:
+ *       200:
+ *         description: OK
+ *       404:
+ *         description: 用户不存在
+ */
+const userUpdate = {
+  method: 'put',
+  path: '/api/users/:id',
+  paramsSchema: {
+    type: 'object',
+    required: ['id'],
+    properties: { id: { type: 'integer', minimum: 1 } }
+  },
+  bodySchema: {
+    type: 'object',
+    properties: {
+      password: { type: 'string', minLength: 6 },
+      email: { type: 'string', format: 'email' },
+      phone: { type: 'string' },
+      status: { type: 'integer' }
     }
   },
-  {
-    method: 'put',
-    path: '/api/users/:id',
-    paramsSchema: {
-      type: 'object',
-      required: ['id'],
-      properties: { id: { type: 'integer', minimum: 1 } }
-    },
-    bodySchema: {
-      type: 'object',
-      properties: {
-        password: { type: 'string', minLength: 6 },
-        email: { type: 'string', format: 'email' },
-        phone: { type: 'string' },
-        status: { type: 'integer' }
-      }
-    },
-    async handler(req) {
-      const { id } = req.validatedParams
-      const user = await SysUser.findByPk(id)
-      if (!user) {
-        throw new createHttpError.NotFound('User not found')
-      }
-      await user.update(req.validatedBody)
-      return user
+  async handler(req) {
+    const { id } = req.validatedParams
+    const user = await SysUser.findByPk(id)
+    if (!user) {
+      throw new createHttpError.NotFound('User not found')
     }
+    await user.update(req.validatedBody)
+    return user
+  }
+}
+
+/**
+ * @swagger
+ * /api/users/{id}:
+ *   delete:
+ *     summary: 删除用户
+ *     tags: [Users]
+ *     parameters:
+ *       - in: path
+ *         name: id
+ *         required: true
+ *         schema: { type: integer, minimum: 1 }
+ *     responses:
+ *       200:
+ *         description: OK
+ *       404:
+ *         description: 用户不存在
+ */
+const userDelete = {
+  method: 'delete',
+  path: '/api/users/:id',
+  paramsSchema: {
+    type: 'object',
+    required: ['id'],
+    properties: { id: { type: 'integer', minimum: 1 } }
   },
-  {
-    method: 'delete',
-    path: '/api/users/:id',
-    paramsSchema: {
-      type: 'object',
-      required: ['id'],
-      properties: { id: { type: 'integer', minimum: 1 } }
-    },
-    async handler(req) {
-      const { id } = req.validatedParams
-      const user = await SysUser.findByPk(id)
-      if (!user) {
-        throw new createHttpError.NotFound('User not found')
-      }
-      await user.destroy()
-      return { message: 'User deleted' }
+  async handler(req) {
+    const { id } = req.validatedParams
+    const user = await SysUser.findByPk(id)
+    if (!user) {
+      throw new createHttpError.NotFound('User not found')
     }
+    await user.destroy()
+    return { message: 'User deleted' }
   }
-]
+}
+
+module.exports = {
+  userList,
+  userGet,
+  userCreate,
+  userUpdate,
+  userDelete
+}

package/templates/cjs/src/cronWorker.js

@@ -52,14 +52,11 @@ async function startCronWorker() {
     }
   })
 
-  await framework.runPluginBeforeSetup()
-  await framework.setupModels(path.join(__dirname, './models'))
-  await framework.loadPluginModels()
-  await framework.runPluginAfterSetup()
-
-  await framework.loadCronActions(path.join(__dirname, './cronActions'))
-  await framework.startWorker()
-  framework.start()
+  await framework.setup({
+    modelsDir: path.join(__dirname, './models'),
+    cronActionsDir: path.join(__dirname, './cronActions')
+  })
+  await framework.start()
   logger.info('[cron-worker] Cron worker started')
 
   // 未捕获异常：打印堆栈后直接退出。OS / 进程管理器负责回收资源。

package/templates/mjs/src/app.js

@@ -85,13 +85,13 @@ async function bootstrap() {
     }
   })
 
-  await framework.runPluginBeforeSetup()
-  await framework.setupModels(path.join(__dirname, './models'))
-  await framework.loadPluginModels()
-  await framework.runPluginAfterSetup()
-
   const app = framework.createApp()
 
+  await framework.setup({
+    modelsDir: path.join(__dirname, './models'),
+    controllersDir: path.join(__dirname, './controllers')
+  })
+
   app.disable('x-powered-by')
   app.disable('etag')
 
@@ -128,8 +128,10 @@ async function bootstrap() {
     logger.info(`[app] Swagger UI disabled (env: ${process.env.NODE_ENV || 'unset'})`)
   }
 
-  await framework.loadControllers(path.join(__dirname, './controllers'))
-  await framework.loadPluginControllers()
+  await framework.loadControllers()
+
+  // 错误日志中间件：挂在所有路由之后，记录业务错误并继续传递给默认错误处理。
+  app.use(expressErrorHandler())
 
   framework.start(Number(process.env.PORT) || 3000)
 

package/templates/mjs/src/controllers/hello.js

@@ -16,6 +16,21 @@
  *                 message: { type: string, example: 'Welcome to SKWeb!' }
  *                 version: { type: string, example: '1.0.0' }
  *                 timestamp: { type: string, format: date-time }
+ */
+const helloIndex = {
+  method: 'get',
+  path: '/',
+  async handler() {
+    return {
+      message: 'Welcome to SKWeb!',
+      version: '1.0.0',
+      timestamp: new Date().toISOString()
+    }
+  }
+}
+
+/**
+ * @swagger
  * /health:
  *   get:
  *     summary: 健康检查
@@ -30,6 +45,20 @@
  *               properties:
  *                 status: { type: string, example: 'ok' }
  *                 timestamp: { type: string, format: date-time }
+ */
+const helloHealth = {
+  method: 'get',
+  path: '/health',
+  async handler() {
+    return {
+      status: 'ok',
+      timestamp: new Date().toISOString()
+    }
+  }
+}
+
+/**
+ * @swagger
  * /echo:
  *   post:
  *     summary: 回显请求体
@@ -44,36 +73,19 @@
  *       200:
  *         description: OK
  */
-export default [
-  {
-    method: 'get',
-    path: '/',
-    async handler() {
-      return {
-        message: 'Welcome to SKWeb!',
-        version: '1.0.0',
-        timestamp: new Date().toISOString()
-      }
-    }
-  },
-  {
-    method: 'get',
-    path: '/health',
-    async handler() {
-      return {
-        status: 'ok',
-        timestamp: new Date().toISOString()
-      }
-    }
-  },
-  {
-    method: 'post',
-    path: '/echo',
-    async handler(req) {
-      return {
-        message: 'Echo received',
-        data: req.body
-      }
+const helloEcho = {
+  method: 'post',
+  path: '/echo',
+  async handler(req) {
+    return {
+      message: 'Echo received',
+      data: req.body
     }
   }
-]
+}
+
+export default {
+  helloIndex,
+  helloHealth,
+  helloEcho
+}