openapi-sampler
Tool for generation samples based on OpenAPI payload/response schema
Features
- Deterministic (given a particular input, will always produce the same output)
- Supports compound keywords:
allOf,oneOf,anyOf,if/then/else - Supports
additionalPropertieswithx-additionalPropertiesName - Uses
const,examples,enumanddefaultwhere possible - in this order - Good array support: supports
contains,minItems,maxItems, and tuples (itemsas an array) - Supports
minLength,maxLength,min,max,exclusiveMinimum,exclusiveMaximum, (limited)pattern - Supports the following
stringformats:
- Infers schema type automatically following same rules as json-schema-faker
- Support for
$refresolving - Has basic supports for JSON Schema draft 7 (thanks to @P0lip from @stoplightio for contributing)
Installation
Install using npm
npm install openapi-sampler
or using yarn
yarn add openapi-sampler
Then require it in your code:
var OpenAPISampler = require('openapi-sampler');Usage
OpenAPISampler.sample(schema, [options], [spec])
- schema (_required_) -
object
- options (_optional_) -
object
boolean
Don't include non-required object properties not specified in required property of the schema object
- skipReadOnly - boolean
Don't include readOnly object properties
- skipWriteOnly - boolean
Don't include writeOnly object properties
- quiet - boolean
Don't log console warning messages
- spec - whole specification where the schema is taken from. Required only when schema may contain
$ref. spec must not contain any external references
Example
const OpenAPISampler = require('.');
OpenAPISampler.sample({
type: 'object',
properties: {
a: {type: 'integer', minimum: 10},
b: {type: 'string', format: 'password', minLength: 10},
c: {type: 'boolean', readOnly: true}
}
}, {skipReadOnly: true});
// { a: 10, b: 'pa$$word_q' }