Comments (6)
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.
from joi-to-swagger.
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.
from joi-to-swagger.
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.
from joi-to-swagger.
ok, thanks!
from joi-to-swagger.
@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.
from joi-to-swagger.
@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.
from joi-to-swagger.
Related Issues (20)
- Usage of joi.ref() in min()/max() generated invalid schemas
- [Feature request] Support Joi.link() HOT 1
- Update joi dependency to use @hapi/joi HOT 5
- regeneratorRuntime - error HOT 3
- Meta options (className, swagger and swaggerOverride) HOT 1
- [FEATURE] Support for schema.tailor and schema.alter HOT 2
- joi is leaving the @hapi organization and moving back to 'joi' HOT 2
- False default values for boolean not passing HOT 2
- joi.object().keys() vs joi.object({}) HOT 1
- add meta option to override alternatives feature (for AWS APIG) HOT 1
- Custom data x-custom-definition / x-custom-property-data HOT 1
- Support for .allow('a','b') by setting enums for this
- Description feature HOT 3
- How to create joi schema of allOf: swagger syntax HOT 1
- thank you for this
- Generate parameters array HOT 1
- Set responses using joi HOT 1
- Key-Value Map via Joi.object().pattern() does not work
- Generation of components using .pattern() HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from joi-to-swagger.