THIS REPO HAS BEEN DEPRECATED. THE DEVELOPMENT HAS MOVED TO A NEW REPOSITORY: https://github.com/NeuraLegion/har-sdk
Tool for generation samples based on OpenAPI payload/response schema
- deterministic (given a particular input, will always produce the same output)
- Supports
allOf
- Supports
additionalProperties
- Uses
default
,const
,enum
andexamples
where possible - Full array support: supports
minItems
, and tuples (items
as an array) - Supports
minLength
,maxLength
,min
,max
,exclusiveMinimum
,exclusiveMaximum
- Supports the next
string
formats:- password
- date-time
- date
- ipv4
- ipv6
- hostname
- uri
- Infers schema type automatically following same rules as json-schema-faker
- Support for
$ref
resolving
Install using npm
npm install @neuralegion/openapi-sampler --save
or using yarn
yarn add @neuralegion/openapi-sampler
Then require it in your code:
var OpenAPISampler = require('@neuralegion/openapi-sampler');
- schema (required) -
object
A OpenAPI Schema Object - options (optional) -
object
Available options:- skipNonRequired -
boolean
Don't include non-required object properties not specified inrequired
property of the schema object - skipReadOnly -
boolean
Don't includereadOnly
object properties - skipWriteOnly -
boolean
Don't includewriteOnly
object properties - quiet -
boolean
Don't log console warning messages
- skipNonRequired -
- spec - whole specification where the schema is taken from. Required only when schema may contain
$ref
. spec must not contain any external references
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' }