Comments (1)
Hello,
joi-to-swagger will only create schemas, the definition for example of parameters is not in the scope of that library.
I also want to point out, that joi-to-swagger will create OpenAPI v3 compliant schemas. In your example, you use a parameter with in: 'body'
, which is not OpenAPI v3 but Swagger (v2).
For your question, to create the components tree you described I have written the following code:
const j2s = require('joi-to-swagger');
const joi = require('joi');
const pagination = joi.object({
perPageRecords: joi.number().integer(),
pageNo: joi.number().integer(),
}).meta({ className: 'pagination' });
const sort = joi.object({
sorts: joi.array().items(joi.object({
fieldName: joi.string(),
direction: joi.string(),
}).unknown()),
}).unknown().label('sort').meta({ className: 'sort' });
const components = { schemas: {} };
Object.assign(components.schemas, j2s(pagination, components).components.schemas);
Object.assign(components.schemas, j2s(sort, components).components.schemas);
console.log(JSON.stringify(components, null, 2));
resulting in
{
"schemas": {
"pagination": {
"type": "object",
"properties": {
"perPageRecords": {
"type": "integer"
},
"pageNo": {
"type": "integer"
}
},
"additionalProperties": false
},
"sort": {
"type": "object",
"properties": {
"sorts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldName": {
"type": "string"
},
"direction": {
"type": "string"
}
}
}
}
},
"title": "sort"
}
}
}
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
- More examples HOT 6
- 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
- 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.