valibot support openapi

[PandaWorker]

I really like valibot. I understand that it is still at the development stage.

Will there be support for generating openapi schemas in the future?
I know a very good Python library, pydantic, everything is implemented there very conveniently. From class-based validation and openapi generation out of the box.

If there is openapi support out of the box it will be the best fastify + valibot combination

[fabian-hiller]

Can you give me more context on this? What exactly is an OpenAI schema?

[PandaWorker]

https://fastify.dev/docs/latest/Reference/Validation-and-Serialization/

Usage example:

const RegistrationBodySchema = object({
    username: string().openApi({description: 'a', defult: 'anonym'}),
    password: string()
});

const opts = {
  schema: {
      body: RegistrationBodySchema.openApi
    }
  }
}

fastify.get('/', opts, (request, reply) => {
  reply.send({ params: request.body}) // echo the body
});

[fabian-hiller]

Without understanding everything, it seems to be out-of-scope to generate an OpenAI schema. Valibot is primarily a schema library to validate data. However, with our modular design, it seems possible to me to build this functionality on top of Valibot in a separate project.

[bingtsingw]

There is an zod-to-openapi lib maybe we can learn from it.

[fabian-hiller]

That's cool. If anyone wants to create such a package or port the code from this one to Valibot, feel free to add it to our ecosystem page: https://valibot.dev/guides/ecosystem/

[ironnysh]

There's this tool. Maybe it can help

[camflan]

I have started a project: /~https://github.com/camflan/valibot-openapi-generator

I'm using it in production for a client project but it definitely needs help to be where I'd like it to be 😅

[fabian-hiller]

Amazing! Feel free to reach out if you have any questions. Also, feel free to add your project to our ecosystem page: https://valibot.dev/guides/ecosystem/

[fabian-hiller]

Not sure if this helps, but feel free to take a look at the source code of @valibot/to-json-schema, which converts Valibot schemas to JSON schema: /~https://github.com/fabian-hiller/valibot/tree/main/packages/to-json-schema

[fabian-hiller]

There is a OpenAPI package for Hono that supports Valibot: /~https://github.com/rhinobase/hono-openapi

Here is a related article with more details: https://dev.to/mathuraditya7/introducing-hono-openapi-simplifying-api-documentation-for-honojs-2e0e