Docs

Open API

This is a plugin that provides an Open API reference for Better Auth. It shows all endpoints added by plugins and the core. It also provides a way to test the endpoints. It uses Scalar to display the Open API reference.

This plugin is still in the early stages of development. We are working on adding more features to it and filling in the gaps.

Installation

Add the plugin to your auth config

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

Each plugin endpoints are grouped by the plugin name. The core endpoints are grouped under the Default group. And Model schemas are grouped under the Models group.

Open API reference

Usage

The Open API reference is generated using the OpenAPI 3.0 specification. You can use the reference to generate client libraries, documentation, and more.

The reference is generated using the Scalar library. Scalar provides a way to view and test the endpoints. You can test the endpoints by clicking on the Try it out button and providing the required parameters.

Open API reference

Generated Schema

To get the generated Open API schema directly as JSON, you can do auth.api.generateOpenAPISchema(). This will return the Open API schema as a JSON object.

import { auth } from "~/lib/auth"
 
const openAPISchema = await auth.api.generateOpenAPISchema()
console.log(openAPISchema)

Configuration

path - The path where the Open API reference is served. Default is /api/auth/reference. You can change it to any path you like, but keep in mind that it will be appended to the base path of your auth server.

disableDefaultReference - If set to true, the default Open API reference UI by Scalar will be disabled. Default is false.

OAuth Proxy

OAuth Proxy plugin for Better Auth

JWT

Authenticate users with JWT tokens in services that can't use the session

Edit on GitHub

On this page