Cookbook

Cookbook 是适用于 Milkio 的文档工具，它可以分析你的代码，并依据注释来为你生成在线文档。其中请求和响应的部分都是自动推断出来的，不需要你编写任何说明。它当前还处于 alpha 阶段，未来，我们还会为 Cookbook 引入更多的功能，来帮助你更愉快地构筑梦想。

暂时的，Cookbook 还处于原始版本的开发阶段，因此它还有一些 bug，以及本文档还不够完善详细。在未来，这些都会改进。目前，可以 点击这里 来使用它。

使用

在你的 /src/apps 中，新建一个 API，文件名为 cookbook.ts。填入以下内容：

import { defineApi, reject } from "milkio";
import { cwd } from "node:process";
import { join } from "path";
import type typia from "typia";

export const api = defineApi({
  meta: {
    //
  },
  async action(params: string, context) {
    const password = "Pa$$w0rd!";
    if (params !== password) throw reject("BUSINESS_FAIL", "Only with the correct parameters can Cookbook be accessed");
    return Bun.file(join(cwd(), "generated", "cookbook.json")).json();
  },
});

其中的 password 部分，是用来限制你的 cookbook.json 不会泄露出去。你也可以自由地编写你希望的验证逻辑，或者不验证，公开给任何人。

打开 Cookbook 网站，点击 Edit Connect Config，将下面的 JSON 粘贴进去，这是连接你刚刚编写的API所需要的配置。

{
  "Local Origin": {
    "cookbook": "http://localhost:9000/cookbook",
    "base": "http://localhost:9000/",
    "params": "Pa$$w0rd!",
    "headers": {}
  }
}

不出意外，你就可以 使用 Cookbook 来阅读你 Milkio 的所有文档了。

暂时的，Cookbook 还不是很完善，如果你想改进它或者修复一些 bug，可以前往 Cookbook 仓库。