More examples about joi-to-swagger

[Mairu]

This library helps to create openapi v3 schemas from joi object validation definitions.
Either you have another library to create the rest of your openapi specification or you have to create it yourself. You should read into the openapi specification.

The 2nd parameter refers to the https://swagger.io/docs/specification/components/ when references can be reused.

[damiancipolat]

OK I understand but I can't find an executable example from this library, could you upload at least one that shows an input / output? of the schemas.

[Mairu]

It is the first thing in the readme :D

(The output is the swagger property of the return object, in components there would be schemas, if you work with them).

But you are right, some more detailed examples would help, I will add some, when I have time for it.

[damiancipolat]

ok, thanks!

[wll8]

@Twipped @Mairu
Can you add an example with more parameters? It is very helpful for those who are not familiar with openApi but want to use it with this library.

[Mairu]

@wll8 Well there is no need for more parameters.
How you define your joi schema, depends on your requirements.

And how you create the OpenAPI documents depends on the library which you should use for creating and serving the OpenAPI specification.

So if are you using anything already and don't know how to put it together, then please list them. Or at least list the libraries you are using to give some hints on how to help you.