Open API
这是一个为 Better Auth 提供 Open API 参考文档的插件。它展示了由插件和核心添加的所有端点，并提供了测试这些端点的方法。该插件使用 Scalar 来显示 Open API 参考文档。
该插件仍处于早期开发阶段。我们正在努力为其添加更多功能并填补空白。
安装
将插件添加到你的 auth 配置中
import { betterAuth } from "better-auth"
import { openAPI } from "better-auth/plugins"
export const auth = betterAuth({
plugins: [
openAPI(),
]
})导航到 /api/auth/reference 查看 Open API 参考文档
每个插件的端点都按插件名称分组。核心端点分组在 Default 组下。模型模式（Model schemas）分组在 Models 组下。
使用方法
Open API 参考文档是使用 OpenAPI 3.0 规范生成的。你可以使用此参考文档来生成客户端库、文档等。
该参考文档是使用 Scalar 库生成的。Scalar 提供了一种查看和测试端点的方法。你可以通过点击 Try it out 按钮并提供所需参数来测试端点。
生成的模式（Schema）
要直接获取生成的 Open API 模式（Schema）作为 JSON，你可以执行 auth.api.generateOpenAPISchema()。这将返回一个 JSON 格式的 Open API 模式对象。
import { auth } from "~/lib/auth"
const openAPISchema = await auth.api.generateOpenAPISchema()
console.log(openAPISchema)配置
path - 用于提供 Open API 参考文档的路径。默认为 /api/auth/reference。您可以将其更改为任何您喜欢的路径，但请注意该路径将附加到认证服务器的基本路径之后。
disableDefaultReference - 如果设置为 true，将禁用 Scalar 提供的默认 Open API 参考界面。默认为 false。