new: add community-maintained extension package explanation#1665
new: add community-maintained extension package explanation#1665Myxogastria0808 wants to merge 4 commits intohonojs:mainfrom
Conversation
|
There was a problem hiding this comment.
Pull request overview
Adds documentation to the @hono/zod-openapi package README to point users to a community-maintained extension for sharing/reusing OpenAPI response definitions.
Changes:
- Introduces a new “Community Extensions” section in the
@hono/zod-openapiREADME - Adds a short description and links for the
zod-openapi-sharecommunity package
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### zod-openapi-share | ||
|
|
||
| `zod-openapi-share` is a **community-maintained** extension package for `@hono/zod-openapi` that lets you centralize and reuse response definitions across endpoints. | ||
| Normally, `@hono/zod-openapi` requires you to redefine the same responses (e.g., error schemas) for every endpoint, but with `zod-openapi-share`, you can avoid repetition and prevent definition drift, making your backend development using `hono` + `@hono/zod-openapi` cleaner and more consistent. |
There was a problem hiding this comment.
In prose, "hono" is referred to elsewhere in this README as the framework name "Hono". Consider capitalizing it here for consistency (the package name can remain hono when referring to npm/install).
| Normally, `@hono/zod-openapi` requires you to redefine the same responses (e.g., error schemas) for every endpoint, but with `zod-openapi-share`, you can avoid repetition and prevent definition drift, making your backend development using `hono` + `@hono/zod-openapi` cleaner and more consistent. | |
| Normally, `@hono/zod-openapi` requires you to redefine the same responses (e.g., error schemas) for every endpoint, but with `zod-openapi-share`, you can avoid repetition and prevent definition drift, making your backend development using Hono + `@hono/zod-openapi` cleaner and more consistent. |
| - GitHub: https://github.com/Myxogastria0808/zod-openapi-share | ||
| - npm: https://www.npmjs.com/package/zod-openapi-share |
There was a problem hiding this comment.
These bullets use raw URLs; elsewhere in this README links are typically formatted as Markdown links (e.g., ## References uses - [Hono](https://hono.dev/) around lines 542–546). Consider switching these to Markdown link syntax for consistency/readability.
| - GitHub: https://github.com/Myxogastria0808/zod-openapi-share | |
| - npm: https://www.npmjs.com/package/zod-openapi-share | |
| - GitHub: [Myxogastria0808/zod-openapi-share](https://github.com/Myxogastria0808/zod-openapi-share) | |
| - npm: [zod-openapi-share](https://www.npmjs.com/package/zod-openapi-share) |
The author should do the following, if applicable
This PR adds a short section to the @hono/zod-openapi README introducing a community-maintained extension, zod-openapi-share, which helps centralize and reuse common OpenAPI response definitions.
The extension is clearly marked as non-official and is intended to complement @hono/zod-openapi in real-world API development.
yarn changesetat the top of this repo and push the changeset