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.
- PHP ^7.3
Important notice! While PHP 8.0 declared in composer.json this package hasn't been tested against it.
Run in terminal:
composer require ybelenko/openapi-data-mockerImagine we have OpenAPI Specification 3.0.3 - Schema Object like this:
description: Real world example schema type: object properties: id: type: integer format: int32 minimum: 1 purchased_items: type: array items: type: object properties: SKU: type: string format: uuid maxLength: 20 quantity: type: integer format: int32 minimum: 1 maximum: 5 price: type: object properties: currency: type: string minLength: 3 maxLength: 3 enum: - USD - EUR - RUB value: type: number format: float minimum: 0.01 maximum: 99.99 manufacturer: type: object properties: name: type: string maxLength: 30 country: type: string enum: - CHN - USA - RUS buyer: type: object properties: first_name: type: string minLength: 3 maxLength: 15 last_name: type: string minLength: 3 maxLength: 15 credit_card: type: integer minimum: 1000000000000000 maximum: 10000000000000000 phone: type: integer minimum: 10000000000000 maximum: 99999999999999 email: type: string format: email status: type: string enum: - registered - paid - shipped - delivered default: registered created_at: type: string format: date-timeNotice! While schema object presented in YAML format this library doesn't support YAML or JSON parsing right now. It means that
mockSchemaObjectmethod expects already decoded JSON value as argument.
When we mock mentioned schema with mockSchemaObject method:
require __DIR__ . '/vendor/autoload.php'; use OpenAPIServer\Mock\OpenApiDataMocker as Mocker; $mocker = new Mocker(); // set model classes namespace for $ref handling // current example doesn't use $refs in schemas, however $mocker->setModelsNamespace('JohnDoesPackage\\Model\\'); // class InvoiceTest contains schema mentioned previously // it returns that schema with getOpenApiSchema() method declared in OpenAPIServer\Mock\BaseModel parent class $schema = \OpenAPIServer\Mock\Model\InvoiceTest::getOpenApiSchema(); $data = $mocker->mockSchemaObject($schema); echo json_encode($data, \JSON_PRETTY_PRINT);the output looks like:
{ "id": 1912777939, "purchased_items": [ { "SKU": "5ee78cfde9f05", "quantity": 4, "price": { "currency": "EUR", "value": 57.635 }, "manufacturer": { "name": "Lorem i", "country": "USA" } } ], "buyer": { "first_name": "Lorem ipsum do", "last_name": "Lorem ipsum ", "credit_card": 2455087473915908, "phone": 65526260517693, "email": "jfkennedy@example.com" }, "status": "delivered", "created_at": "1978-08-08T04:03:09+00:00" }Of course that output will be slightly different on every call. That's what mocker package has been developed for.
You can check extended example at examples/extended_example.php.
All data types supported except specific string formats: email, uuid, password which are poorly implemented.
| 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 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 |
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