Open API

Better Auth提供Open API参考文档的插件。它显示了由插件和核心添加的所有端点。它还提供了测试端点的方法。它使用Scalar来显示Open API参考文档。

安装

import { betterAuth } from "better-auth"
import { openAPI } from "better-auth/plugins"
 
export const auth = betterAuth({
    plugins: [ 
        openAPI(), 
    ] 
})

使用方法

Open API参考文档是使用OpenAPI 3.0规范生成的。您可以使用该参考文档生成客户端库、文档等。

参考文档是使用Scalar库生成的。Scalar提供了查看和测试端点的方法。您可以通过点击Try it out按钮并提供所需参数来测试端点。

生成的架构

要直接获取生成的Open API架构作为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。您可以将其更改为任何您喜欢的路径，但请记住，它将附加到您的auth服务器的基本路径上。

disableDefaultReference - 如果设置为true，将禁用Scalar提供的默认Open API参考UI。默认为false。