Openapi Data Mocker

Openapi Data Mocker helps to generate fake data from OpenAPI 3.0 documents. Most of the methods may work with 2.0 version(fka Swagger 2.0), but it's not tested. This package was an enhancement of PHP Slim4 server in OpenAPI Generator project, but it easier to maintain it in separated repo.

Requirements

• PHP ^7.1

Installation via Composer

Run in terminal:

composer require ybelenko/openapi-data-mocker

Usage example

require __DIR__ . '/vendor/autoload.php';

use OpenAPIServer\Mock\OpenApiDataMocker as Mocker;
$mocker = new Mocker();
// set model classes namespace for $ref handling
$mocker->setModelsNamespace('JohnDoesPackage\\Model\\');
$data = [
    'Integer from 1 to 100' => $mocker->mockInteger(null, 1, 100),
    'Float from -3 to 3' =>  $mocker->mockNumber(null, -3, 3),
    'String 10 chars' => $mocker->mockString(null, 10, 10),
    'Boolean' =>  $mocker->mockBoolean(),
    'Array of strings' => $mocker->mockArray(
        [
            'type' => 'string',
            'maxLength' => 20,
        ]
    ),
    'Object' => $mocker->mockObject([
        'id' => [
            'type' => 'integer',
            'minimum' => 1,
            'maximum' => 10
        ],
        'username' => [
            'type' => 'string',
            'maxLength' => 10,
        ]
    ])
];

echo json_encode($data, JSON_PRETTY_PRINT);

Supported features

All data types supported except specific string formats: email, uuid, password which are poorly implemented.

Data Types Support

Data Type	Data Format	Supported
integer	int32	✅
integer	int64	✅
number	float	✅
number	double
string	byte	✅
string	binary	✅
boolean		✅
string	date	✅
string	date-time	✅
string	password	✅
string	email	✅
string	uuid	✅

Data Options Support

Data Type	Option	Supported
string	minLength	✅
string	maxLength	✅
string	enum	✅
string	pattern
integer	minimum	✅
integer	maximum	✅
integer	exclusiveMinimum	✅
integer	exclusiveMaximum	✅
number	minimum	✅
number	maximum	✅
number	exclusiveMinimum	✅
number	exclusiveMaximum	✅
array	items	✅
array	additionalItems
array	minItems	✅
array	maxItems	✅
array	uniqueItems
object	properties	✅
object	maxProperties
object	minProperties
object	patternProperties
object	additionalProperties
object	required
*	$ref	✅
*	allOf
*	anyOf
*	oneOf
*	not

Known Limitations

Avoid circular refs in your schema. Schema below can cause infinite loop and Out of Memory PHP error:

# ModelA has reference to ModelB while ModelB has reference to ModelA.
# Mock server will produce huge nested JSON example and ended with `Out of Memory` error.
definitions:
  ModelA:
    type: object
    properties:
      model_b:
        $ref: '#/definitions/ModelB'
  ModelB:
    type: array
    items:
      $ref: '#/definitions/ModelA'

Don't ref scalar types, because generator will not produce models which mock server can find. So schema below will cause error:

# generated build contains only `OuterComposite` model class which referenced to not existed `OuterNumber`, `OuterString`, `OuterBoolean` classes
# mock server cannot mock `OuterComposite` model and throws exception
definitions:
  OuterComposite:
    type: object
    properties:
      my_number:
        $ref: '#/definitions/OuterNumber'
      my_string:
        $ref: '#/definitions/OuterString'
      my_boolean:
        $ref: '#/definitions/OuterBoolean'
  OuterNumber:
    type: number
  OuterString:
    type: string
  OuterBoolean:
    type: boolean

Links to mentioned technologies

• OpenAPI Specification 3.0.3
• OpenAPI Generator
• Composer