github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-07-16 14:38:30 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[GH-ISSUE #670] How to connect auth with OpenAPIHono ? #8369

New Issue
Closed
opened 2026-04-13 03:26:26 -05:00 by GiteaMirror · 8 comments
GiteaMirror commented 2026-04-13 03:26:26 -05:00
Owner
Copy Link

Originally created by @Malin88 on GitHub (Nov 26, 2024).
Original GitHub issue: https://github.com/better-auth/better-auth/issues/670

I'm trying to do it this way:

const create = createRoute({
  tags: ["auth"],
  method: "post",
  path: "/api/auth/**",
  request: {
    body: {
      content: {
        "application/json": {
          schema: {
            name: z.string(),
            email: z.string().email(),
            password: z.string(),
          },
        },
      },
      description: "Register user",
      required: true,
    },
  },
  responses: {
    200: {
      description: "Registered user",
      content: {
        "application/json": {
          schema: z.object({
            id: z.string(),
            name: z.string(),
            email: z.string().email(),
          }),
        },
      },
    },
  },
});

const app = new OpenAPIHono<AppBindings>({
    strict: false,
    defaultHook,
  });

app.openapi(routes.create, auth.handler(c.req.raw));

But I still have TS errors in the last line:

Argument of type 'Promise<Response>' is not assignable to parameter of type 'Handler<AppBindings, "/api/auth/**", {}, MaybePromise<TypedResponse<{ name: string; email: string; id: string; }, 200, "json" | "text">>>'.
(...)

Has anyone tried to glue this together yet?

Originally created by @Malin88 on GitHub (Nov 26, 2024). Original GitHub issue: https://github.com/better-auth/better-auth/issues/670 I'm trying to do it this way: ```JS const create = createRoute({ tags: ["auth"], method: "post", path: "/api/auth/**", request: { body: { content: { "application/json": { schema: { name: z.string(), email: z.string().email(), password: z.string(), }, }, }, description: "Register user", required: true, }, }, responses: { 200: { description: "Registered user", content: { "application/json": { schema: z.object({ id: z.string(), name: z.string(), email: z.string().email(), }), }, }, }, }, }); const app = new OpenAPIHono<AppBindings>({ strict: false, defaultHook, }); app.openapi(routes.create, auth.handler(c.req.raw)); ``` But I still have TS errors in the last line: ``` Argument of type 'Promise<Response>' is not assignable to parameter of type 'Handler<AppBindings, "/api/auth/**", {}, MaybePromise<TypedResponse<{ name: string; email: string; id: string; }, 200, "json" | "text">>>'. (...) ``` Has anyone tried to glue this together yet?
GiteaMirror added the locked label 2026-04-13 03:26:26 -05:00
GiteaMirror commented 2026-04-13 03:26:28 -05:00
Author
Owner
Copy Link

@Bekacru commented on GitHub (Nov 26, 2024):

You shouldn't do that. Instead, use the OpenAPI plugin provided by Better Auth. If you want to merge them, you can merge the objects instead.

<!-- gh-comment-id:2501920563 --> @Bekacru commented on GitHub (Nov 26, 2024): You shouldn't do that. Instead, use the OpenAPI plugin provided by Better Auth. If you want to merge them, you can merge the objects instead.
GiteaMirror commented 2026-04-13 03:26:29 -05:00
Author
Owner
Copy Link

@Malin88 commented on GitHub (Nov 27, 2024):

Thanks for the advice, is there a way I can somehow connect this to my endpoints? I also use the Scalar library and keep everything under /api/reference it would be nice to have the endpoints from auth as well

<!-- gh-comment-id:2503778236 --> @Malin88 commented on GitHub (Nov 27, 2024): Thanks for the advice, is there a way I can somehow connect this to my endpoints? I also use the Scalar library and keep everything under `/api/reference` it would be nice to have the endpoints from auth as well
GiteaMirror commented 2026-04-13 03:26:29 -05:00
Author
Owner
Copy Link

@ferkanzai commented on GitHub (Nov 28, 2024):

Hi, I'm working with the same stack and I'm not 100% sure how to achieve merging the 2 objects... How can I retrieve the schema object from better-auth OpenAPI plugin?

@Malin88 have you achieved a good result? Thanks in advance!

<!-- gh-comment-id:2505069059 --> @ferkanzai commented on GitHub (Nov 28, 2024): Hi, I'm working with the same stack and I'm not 100% sure how to achieve merging the 2 objects... How can I retrieve the schema object from better-auth OpenAPI plugin? @Malin88 have you achieved a good result? Thanks in advance!
GiteaMirror commented 2026-04-13 03:26:30 -05:00
Author
Owner
Copy Link

@Bekacru commented on GitHub (Nov 28, 2024):

you can get the generated schema. see the docs here:
https://www.better-auth.com/docs/plugins/open-api#generated-schema

I think you should be able to merge the objects with hono docs, but I'll have to look more if it requires more work around.

<!-- gh-comment-id:2505300652 --> @Bekacru commented on GitHub (Nov 28, 2024): you can get the generated schema. see the docs here: https://www.better-auth.com/docs/plugins/open-api#generated-schema I think you should be able to merge the objects with hono docs, but I'll have to look more if it requires more work around.
GiteaMirror commented 2026-04-13 03:26:31 -05:00
Author
Owner
Copy Link

@Malin88 commented on GitHub (Nov 28, 2024):

@Bekacru a small mistake in the documentation. This function in the code is called openAPIGenerator

<!-- gh-comment-id:2506561590 --> @Malin88 commented on GitHub (Nov 28, 2024): @Bekacru a small mistake in the documentation. This function in the code is called `openAPIGenerator`
GiteaMirror commented 2026-04-13 03:26:31 -05:00
Author
Owner
Copy Link

@Bekacru commented on GitHub (Nov 28, 2024):

@Bekacru a small mistake in the documentation. This function in the code is called openAPIGenerator

oh sorry about that. we should rename it to generateOpenAPISchema in the next release tho.

<!-- gh-comment-id:2506577670 --> @Bekacru commented on GitHub (Nov 28, 2024): > @Bekacru a small mistake in the documentation. This function in the code is called `openAPIGenerator` oh sorry about that. we should rename it to `generateOpenAPISchema` in the next release tho.
GiteaMirror commented 2026-04-13 03:26:32 -05:00
Author
Owner
Copy Link

@a-man-called-q commented on GitHub (Jan 8, 2025):

@Malin88 @ferkanzai @Bekacru

I wrote a feat request for the documentation update in #1153

Hope it helps

<!-- gh-comment-id:2576558487 --> @a-man-called-q commented on GitHub (Jan 8, 2025): @Malin88 @ferkanzai @Bekacru I wrote a feat request for the documentation update in #1153 Hope it helps
GiteaMirror commented 2026-04-13 03:26:33 -05:00
Author
Owner
Copy Link

@iamyuu commented on GitHub (May 12, 2025):

Hi @Bekacru, I'm working on this and already achive both schema, but the Better Auth generate tags as Default is there any option to change that? and option to add base path into the operation?

Image

<!-- gh-comment-id:2870322002 --> @iamyuu commented on GitHub (May 12, 2025): Hi @Bekacru, I'm working on this and already achive both schema, but the Better Auth generate tags as `Default` is there any option to change that? and option to add base path into the operation? ![Image](https://github.com/user-attachments/assets/e017ec5c-4ee6-4b51-aa19-33cee933311b)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label locked
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#8369
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?