跳转至内容
There is a version suitable for your browser's language settings. Would you like to go to the english language of the site?
主页文档

安装

H1

每个故事都会有一场盛大的序幕,使用 Milkio 开始一个全新的工程。

安装

在终端中运行它,并回答几个问题,就能够获得一个新的 Milkio 工程。如果安装速度比较缓慢,请检查是否使用了 国内镜像源

终端窗口
bun create milkio

运行你的 Milkio 工程

使用 VS Code 打开你的 Milkio 工程目录,或者将它添加到你的 VS Code 工作区中也可以。

现在,Milkio 已经在 9000 端口中启动!你可以发送一个 POST 请求并带上你的名字,它会帮助你向世界问好~

终端窗口
# Linux 或 MacOS: 可以使用 curl 来快速发送一个请求
curl --request POST 'http://localhost:9000/hello-world/say' --data-raw '{"by":"milkio"}'
终端窗口
# Windows: 可以使用 Invoke-WebRequest 来快速发送一个请求
Invoke-WebRequest -Uri "http://localhost:9000/hello-world/say" -Method Post -Body '{"by":"milkio"}'

API 测试

在 VS Code 的资源管理器面板中,打开 /src/apps/hello-world/say.ts 文件,你就可以看到它的源代码。

代码分为两部分,上方是访问 API 时所执行的动作方法,下方是对 API 的测试。你可以在上方编写你 API 的逻辑,并在下方编写相应的测试代码。

/src/apps/hello-world/say.ts
export const test = defineApiTest(api, [
{
name: "Basic", // 测试的名称
handler: async (test) => {
const result = await test.execute({ params: { by: "milkio" } });
if (!result.success) return test.reject(`The result was not success`);
},
},
]);

客户端

Milkio 可以与客户端共享类型,并拥有自动完成和代码提示。如何开始?

下一步?

现在,你已经成功的创建了一个 Milkio 工程,并了解了 Milkio 基础的开发模式了。我们推荐你先阅读完成 基础功能 章节后,随意探索你感兴趣的部分。

如果你是一名有经验的开发者,在此之前已经正在使用至少一种其他的后端框架,请阅读 去忘记 章节,可以使你在学习 Milkio 的过程中减少许多困惑。