docs: add "how to register schema with refs" (#294)

2023-12-07 21:31:03 +09:00 · 2023-12-07 21:31:03 +09:00 · 80f46a4c40
parent 186ce0db8e
commit 80f46a4c40
1 changed files with 4 additions and 0 deletions
--- a/packages/zod-openapi/README.md
+++ b/packages/zod-openapi/README.md
@ -51,6 +51,10 @@ const UserSchema = z
  .openapi('User')
 ```

+> [!TIP]
+> `UserSchema` schema will be registered as `"#/components/schemas/User"` refs in the OpenAPI document.
+> If you want to register the schema as referenced components, use `.opanapi()` method.
+
 Next, create a route:

 ```ts