Midway Hooks 常见问题解决方案

Midway Hooks 常见问题解决方案

hooks "Zero" Api / Type Safe / Fullstack Kit / Powerful Backend 项目地址: https://gitcode.com/gh_mirrors/hoo/hooks

项目基础介绍

Midway Hooks 是一个基于 Midway 框架的全栈开发解决方案，旨在提供“零”API、类型安全、全栈工具包和强大的后端支持。该项目使用 TypeScript 作为主要的编程语言，同时支持前端和后端开发，能够与 React、Vue、Svelte 等框架无缝集成。

新手常见问题与解决方案

问题一：如何初始化一个 Midway Hooks 项目？

问题描述： 新手在使用 Midway Hooks 时，不知道如何创建和初始化一个项目。

解决步骤：

1. 确保已经安装了 Node.js 和 npm。

2. 在命令行中运行以下命令来创建一个新的 Midway Hooks 项目：

   npm init midway
   

3. 按照命令行提示，选择合适的配置选项，包括项目名称、描述、版本等。

4. 完成初始化后，进入项目目录，运行以下命令启动项目：

   npm run dev
   

问题二：如何定义和调用 API？

问题描述： 新手在使用 Midway Hooks 时，不清楚如何定义和调用后端 API。

解决步骤：

1. 在项目中的 src/api 目录下创建一个新的 TypeScript 文件，例如 index.ts。

2. 引入所需的 Api 函数和其他相关类型：

   import { Api, Get, Post, Validate, Query, useContext } from '@midwayjs/hooks';
   import { z } from 'zod';
   

3. 使用 Api 函数定义 API，例如创建一个获取文章列表的 API：

   export const getArticles = Api(Get(), Query<[page: string, per_page: string]>(), async () => {
       const ctx = useContext();
       // 调用数据库操作获取文章数据
       return await db.articles.find([page: ctx.query.page, per_page: ctx.query.per_page]);
   });
   

4. 在前端代码中，使用 useRequest 钩子调用后端 API。

问题三：如何进行类型校验？

问题描述： 新手在使用 Midway Hooks 时，不了解如何进行数据类型的校验。

解决步骤：

1. 在定义 API 的文件中，使用 zod 库来定义数据类型，例如：

   const ArticleSchema = z.object([
       z.string().min(3).max(16),
       z.string().min(1),
   ]);
   

2. 在 API 定义中使用 Validate 函数来校验传入的数据：

   export const createArticle = Api(Post(), Validate(ArticleSchema), async (article) => {
       // 创建文章
       return await db.articles.create(article);
   });
   

3. 如果数据不符合定义的类型，Midway Hooks 会自动抛出错误，阻止不合法数据的处理。

hooks "Zero" Api / Type Safe / Fullstack Kit / Powerful Backend 项目地址: https://gitcode.com/gh_mirrors/hoo/hooks