eat-simple-schema
v0.0.13
Published
Produce Swagger compliant YAML schema given a source file of Meteor SimpleSchema
Downloads
2
Readme
eat-simple-schema
Description
To the extent possible, generate Swagger API schema from Meteor simple schema automatically.
Installation
npm install --save eat-simple-schema
Usage
- Find the schema file you want to document
- replace
aldeed:meteor/simpleschema
witheat-simple-schema
- create a script that will load your modified SimpleSchema and log the YAML. For example:
import * as OL from 'api/OrderLines/schema';
//Give each schema a 'swag_name' prop that holds the identifier
Object.keys(OL).forEach((key) => {
OL.swag_name = key;
});
//log the YAML to the console
Object.values(OL).forEach((val) => {
console.log(val.swag_name)
console.log(val.toYaml(2));
});